Sphinx 自动摘要：如何删除 __init__ 的自动成员

Question

问题

我正在为我的 python 包使用sphinx.ext.autosummary。问题是.. autosummary:: 总是添加.. automethod:: __init__，即使没有记录。

与此同时，我找到了各种方法将其第三次包含（作为特殊成员）或包含在方法中；但不是我如何摆脱.. automethod:: __init__。

如图所示，这只是复制了上面的类规范，根本没有用处。当然，我可以手动创建所有*.rsts，但这不是一种选择，并且会使自动摘要有些过时。此外，由于duplicate object description（__init__ 也在方法中，这很好），它会产生警告。

系统

• python 3.8.5
• sphinx-build 4.0.2（带引导主题）

有没有人有我从几个小时以来一直在寻找的黄金提示？ :)

提前非常感谢！

Answer 1

---

解决方案

在templates_path（参见conf.py；通常为"_templates"）中创建一个文件夹autosummary。搜索默认的class.rst，将其复制到新文件夹（_templates/autosummary/class.rst）并根据需要调整模板。不需要其他任何东西。

我对@9​​87654327@的调整

• 在.. autoclass:: {{ objname }} 之后添加:noindex:。
• 删除行.. automethod:: __init__。
• 需要弄清楚:noindex: 作为默认值是否是个好主意。

非常感谢@mzjn，这是我错过的提示；拯救了我的一天！