如何定制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
解决方案
如果您执行以下操作,它应该可以工作:
- 确保在配置文件中将
templates_path
配置变量的值设置为['_templates']
。 - 将自定义模板放在
_templates
子目录中。 使用
:template:
选项:.. autosummary:: :template: mytemplate.rst
相关文章