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

Question

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

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

有没有办法为使用 autodoc 记录的每个类自动创建此 toctree？

Answer 1

在你的 conf.py 文件中为 sphinx 添加

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 为例。

希望对您有所帮助!