python - 自动为 Sphinx 中的 autodoc 类创建目录树

Question

我希望增加我的一个库中的文档。我一直在使用 sphinx 来帮助构建文档，最近开始探索 autodoc 扩展。

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

有没有办法为使用 autodoc 记录的每个类自动创建这个目录树？

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

我将目录树放在我的 index.rst 中，它看起来像这样：

.. autosummary::
     :toctree: stubs

     Class1
     Class2
     Class3

有关conf.py 设置，请参见此示例

这个例子是一个目录树的例子。

希望有帮助！