自动为Sphinx中的autodoc类创建toctree

Question

我希望增加我的一个图书馆的文件。我一直在使用sphinx来帮助构建文档，并且最近开始探索autodoc扩展。

在大多数专业文档中，每个类文档页面似乎都有所有已记录方法的列表，其顶部是链接。或者，换句话说，是顶部的toctree，带有指向每个更深入的方法文档的超链接。

是否有一种方法可以为使用autodoc记录的每个类自动创建此toctree？

Answer 1

在[狮身人面像的conf.py文件中添加

extensions = ['sphinx.ext.autosummary',]
# NOTE: Don't overwrite your old extension list! Just add to it!

autodoc_default_flags = ['members']
autosummary_generate = True

我将toctree放在index.rst中，它看起来像这样：

.. autosummary::
     :toctree: stubs

     Class1
     Class2
     Class3

请参阅this example了解conf.py设置

和this example为toctree的示例。

希望有帮助！