是否有显示使用狮身人面像一个“类”列表/选项卡,或组织产生出由类成员,类在视觉上很好地分离HTML页面的方法吗?
我使用的狮身人面像1.1.3,一个尝试记录一个Python扩展(自定义一个与用Cython创建)。 我的问题是,如果我进入模块选项卡(这是相当不可读),并用另一只手,“索引”选项卡合并在一起的一切(这是正常的)整个扩展显示在一个单独的块。 我想每类显示器(什么Doxygen的会做一些更接近)。
请问是这样的:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
* :ref:`classindex` ???
存在?
非常感谢。
的autosummary
延伸,与autosummary_generate
设置为配置变量True
,可用于1)产生紧凑摘要列表和2),每个类中的一个页面生成类的文档。
你必须明确地指定要包括各阶层,但一旦做到这一点,你必须生成清晰的文档所在班在视觉上很好地分离的设置。
下面的标记将输出一个“存根”为每个类(1类,等级2,3类).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
详情点击此处: http://sphinx-doc.org/ext/autosummary.html