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

2022-04-21 00:00:00 python python-sphinx

问题描述

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
    

相关文章