python-sphinx - 使用带有 'autodoc' 的 sphinx 按类对显示进行排序？

Question

有没有办法使用 Sphinx 显示“类”列表/选项卡，或者组织生成的 html 页面以按类显示成员，类在视觉上很好地分开？

我使用 Sphinx 1.1.3，尝试记录 Python 扩展(使用 Cython 创建的自定义扩展)。
我的问题是，如果我进入模块选项卡(这很不可读)，整个扩展程序会显示在一个 block 中，另一方面，“索引”选项卡会将所有内容合并在一起(这是正常的)。我想要一个每个类(class)的展示(更接近 Doxygen 的做法)。

做类似的事情:

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

* :ref:`classindex`  ???

存在吗？

非常感谢。

Answer 1

autosummary扩展名，带有 autosummary_generate配置变量设置为 True , 可用于 1) 生成紧凑的摘要列表和 2) 生成每个类一页的类文档。

您必须明确指定要包含的每个类，但是一旦完成，您就可以生成清晰的文档，其中类在视觉上很好地分开。

以下标记将为每个类(Class1、Class2、Class3)输出一个“ stub ”.rst 页。每个页面都基于一个模板并包含一个 .. autoclass::提取完整文档的指令。在最终的 HTML 输出中，每个类页面都从主自动摘要表中的相应条目链接。

:mod:`mymodule` --- Some module
===============================

This module contains several classes. 

.. currentmodule:: mymodule

Class overview
--------------

.. autosummary::
   :toctree: stubs
   :template: class.rst

   Class1
   Class2
   Class3

详情在这里: https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html