使用toctree不为方法创建文档的自动摘要

Question

我正在使用带有numpydoc扩展名和autosummary的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将其自动化。您可以从终端运行它(使用与conf.py文件相同的cd )，如下所示：

自动生成sphinx-

*.rst

Answer 2

似乎需要一个模板来让sphinx为这些方法生成rst文件。在_templates/autosummary下，我添加了一个名为class.rst的文件，它看起来像this，一切正常。