如何自定义sphinx.ext.autosummary rst模板？

Question

在Sphinx的文档中，

Here说明了这些模板可以重新定义的内容。 所以我尝试将module.rst从/site-packages/sphinx/ext/autosummary复制到source/_templates/autosummary（也尝试了source/_templates）稍作修改。但是在重新生成文档后，没有任何改变。

也许我应该在.. autosummary::标签中添加一些特定选项来指定自定义模板目录？ （在conf.py目录中设置正确，sphinx也参见html模板）

UPD：源代码https://github.com/actionless/wooper/blob/debug-autosummary/docs.sh

Answer 1

如果您执行以下操作，它应该有效：

1. 确保将templates_path配置变量的值设置为conf {中的['_templates']。
2. 将自定义模板放在_templates子目录中。

3. 使用:template:选项：

   .. autosummary::
     :template: mytemplate.rst
   

Answer 2

已编辑：我最初在这里发布了错误问题的答案。但是，在这里也可能有所帮助。

• Sphinx autosummary: How to remove automember for __init__

您可以通过将自定义文件添加到 _templates 文件夹来“否决”默认模板。例如，如果要更改调用 autosummary 指令时使用的类的模板，请在此路径下创建自定义 class.rst 文件：

• _templates/autosummary/class.rst

无需显式指定 :template: 即可自动获取。