在斯芬克斯文档中自动生成toc

Question

在狮身人面像中，是否有一种方法可以获得自动模块指令来生成类中成员的TOC？

现在我有

。。内容：

.. topic:: Abstract

   bla bla bla

.. automodule:: ServerCommHandler
    :members:
    :private-members:
    :special-members:
    :show-inheritance:
    :inherited-members:

它工作得很好，但是这个模块中有很多方法，指向该方法的toc将非常好。

Answer 1

图克树怎么样？

.. toctree::

   ServerCommHandler

Answer 2

自动求和扩展将允许autodoc指令(automodule，autoclass)自动添加汇总表，比如内置自动摘要扩展的汇总表。

它可用于以下方面：

pip install autodocsumm

然后编辑您的conf.py以添加扩展：

extensions = [
    'sphinx.ext.autodoc',
    ...,
    'autodocsumm',
]

并在自动文档指令中添加一个:autosummary:选项，例如：

.. automodule: foo.bar
    :autosummary:

如果希望在不显式添加的情况下对所有autodoc指令生效自动摘要，可以通过conf.py这样做，如下所示：

autodoc_default_options = {
    'autosummary': True,
}

如果您使用sphinx动态生成API页面，这尤其有用，因为sphinx很难配置以添加:autosummary:。

自动生成所有API页的conf.py的完整示例：

def setup(app):
    from sphinx.ext import apidoc
    app.connect('builder-inited', lambda _: apidoc.main([
        '-o', './api', '-d2', '-feMT', '../src/PROJECT',
    ]))

extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.intersphinx',
    'sphinx.ext.viewcode',
    'sphinx.ext.githubpages',
    'autodocsumm',
]


autodoc_default_options = {
    'autosummary': True,
}

autodata_content = 'both'