python - 带有 toctree 的自动摘要不为方法创建文档

Question

我正在使用带有 numpydoc 扩展和自动摘要的 sphinx。经过一些实验，我在我的 conf.py 文件中添加了以下选项。

autosummary_generate = True
numpydoc_show_class_members = False

这为我提供了一个新文件，用于如下所示引用的每个类，并且它还创建了所有属性和方法的汇总表。

.. autosummary::
   :toctree: generated/
   :nosignatures:

   MyClass

问题是，虽然文档字符串的第一行有一个方法的汇总表，但方法的名称没有链接到任何东西。如何获取方法的文档字符串以创建它们自己的文件(或至少在与类相同的文件中生成文档)？

Answer 1

首先，确保在您的 conf.py 文件中，字符串 'sphinx.ext.autodoc' 和 'sphinx.ext.autosummary' 在扩展列表中。

其次，您可以在 generate/目录中手动创建名为 mymodule.MyClass.rst 的文件，它可以是这样的:

mymodule.MyClass
================

.. currentmodule:: mymodule

.. autoclass:: MyClass

或者，如果你有很多类，你可以使用 sphinx-autogen 自动化它。您可以从终端(使用 cd 与 conf.py 文件相同)运行它:

sphinx-autogen *.rst