如何定制sphinx.ext.autosumary rst模板?

How to customize sphinx.ext.autosummary rst template?(如何定制sphinx.ext.autosumary rst模板?)
本文介绍了如何定制sphinx.ext.autosumary rst模板?的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

Here在Sphinx的文档中,说那些模板可以重新定义。 因此,我尝试将module.rst/site-packages/sphinx/ext/autosummary复制到source/_templates/autosummary(也只尝试了source/_templates),但做了一些细微的更改。但在我重新生成文档后,没有任何变化。 也许我应该在.. autosummary::标记中添加一些特定选项来指定自定义模板目录?(在conf.py目录中设置正确,也请参见html模板)

更新:源代码:https://github.com/actionless/wooper/blob/master/docs.sh

推荐答案

如果您执行以下操作,它应该可以工作:

  1. 确保在配置文件中将templates_path配置变量的值设置为['_templates']
  2. 将自定义模板放在_templates子目录中。
  3. 使用:template:选项:

    .. autosummary::
      :template: mytemplate.rst
    

这篇关于如何定制sphinx.ext.autosumary rst模板?的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持编程学习网!

本站部分内容来源互联网,如果有图片或者内容侵犯您的权益请联系我们删除!

相关文档推荐

Leetcode 234: Palindrome LinkedList(Leetcode 234:回文链接列表)
How do I read an Excel file directly from Dropbox#39;s API using pandas.read_excel()?(如何使用PANDAS.READ_EXCEL()直接从Dropbox的API读取Excel文件?)
subprocess.Popen tries to write to nonexistent pipe(子进程。打开尝试写入不存在的管道)
I want to realize Popen-code from Windows to Linux:(我想实现从Windows到Linux的POpen-code:)
Reading stdout from a subprocess in real time(实时读取子进程中的标准输出)
How to call type safely on a random file in Python?(如何在Python中安全地调用随机文件上的类型?)