自动模块在 sphinx 文档中生成目录

Question

在 Sphinx 中，有没有办法让 automodule 指令生成类中成员的 TOC？

现在我有

.. 内容：：

.. topic:: Abstract

   bla bla bla

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

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

Answer 1

该autodocsumm扩展将允许车博士指令（automodule，AUTOCLASS）自动添加汇总表像那些内建自动摘要延伸。

它可以按如下方式使用：

pip install autodocsumm

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

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

并:autosummary:为您的 autodoc 指令添加一个选项，例如：

.. automodule: foo.bar
    :autosummary:

如果您想让自动汇总对所有 autodoc 指令生效而不显式添加它们，您可以conf.py按照以下方式进行：

.. automodule: foo.bar
    :autosummary:

如果您使用 sphinx-apidoc 动态生成 API 页面（不容易配置以添加:autosummary:.

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

autodoc_default_options = {
    'autosummary': True,
}

Answer 2

怎么样？

.. toctree::

   ServerCommHandler