使用带有'autodoc'的sphinx按类分类显示？

Question

有没有办法使用Sphinx显示"类"列表/选项卡,或组织生成的html页面按类显示成员,类在视觉上分开？

我使用Sphinx 1.1.3,尝试记录Python扩展(使用Cython创建的自定义扩展).我的问题是如果我进入模块选项卡(这是非常不可读的),整个扩展显示在一个单独的块中,另一方面,"索引"选项卡将所有内容合并在一起(这是正常的).我想要一个每类显示(更接近Doxygen会做什么).

有类似的事情:

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

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

* :ref:`classindex`  ???

存在？

非常感谢.

Answer 1

配置变量设置为的autosummary扩展可用于1)生成紧凑的摘要列表和2)生成每个类一页的类文档.autosummary_generateTrue

您必须明确指定要包含的每个类,但是一旦完成此操作,您就有了一个用于生成清晰文档的设置,其中类在视觉上很好地分开.

以下标记将为每个类(Class1,Class2,Class3)输出一个"stub".st页面.每个页面都基于一个模板,并包含一个.. autoclass::提取完整文档的指令.在最终的HTML输出中,每个类页面都链接到主autosummary表中的相应条目.

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

This module contains several classes. 

.. currentmodule:: mymodule

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

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

   Class1
   Class2
   Class3

详情请访问:http://sphinx-doc.org/ext/autosummary.html