自动总结与toctree没有为方法创建文档

Question

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

autosummary_generate = True
numpydoc_show_class_members = False

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

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

   MyClass

问题在于，尽管文档字符串的第一行有方法的汇总表，但方法的名称不会链接到任何内容。如何获取方法的doc字符串以创建自己的文件（或者至少在与该类相同的文件中生成文档）？

Answer 1

首先，请确保在conf.py文件中，字符串＆＃39; sphinx.ext.autodoc＆＃39;和＆＃39; sphinx.ext.autosummary＆＃39;在扩展名列表中。

其次，您可以在generate /目录中手动创建名为 mymodule.MyClass.rst 的文件，其格式如下：

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

.. currentmodule:: mymodule

.. autoclass:: MyClass

或者，如果你有很多课程，你可以使用sphinx-autogen自动化它。您可以从终端（使用与conf.py文件相同的cd）运行它：

  

sphinx-autogen * .rst