在Sphinx中自动为自动doc类创建toctree

Question

我正在寻找增加我的一个库中的文档.我一直在使用sphinx来帮助构建文档,最近开始探索autodoc扩展.

在大多数专业文档中,每个类文档页面都有一个列表,其中包含顶部链接的所有记录方法.或者,换句话说,顶部的toctree具有到每个更深入的方法文档的超链接.

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

Answer 1

在你conf.py的sphinx add文件中

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

有关conf.py设置,请参阅此示例

和本实施例中为toctree的一个例子.

希望有所帮助!