5

这个问题的灵感来自Mayavi 文档，其中有很好的分节符，每个模块成员之间描述的函数名称。

我.rst现在看起来像：

SQLAlchemy Tables
**********************************

.. automodule:: ExperimentOrganizer.table_def
    :members:

（在模块本身中包含所有文档格式的文本。）

有没有一种简单的方法来表明我想在每个成员之间插入节标题:members:？如果没有，Mayavi 人是怎么做到的？

4

2 回答 2

3

可以告诉 Sphinx“自动模块”在成员之间自动插入分节符吗？

不，没有神奇的选择automodule或类似的东西。如果您想要节标题，那么您必须自己（可能通过使用脚本）将它们添加到 reST 源。另请参阅此类似问题的答案：Sphinx customizing autoclass output。

您引用的Mayavi 文档不是使用autodoc创建的。使用function指令（不是autofunction）记录功能。单击“显示源”以查看 reST 标记。

于 2013-09-17T18:19:14.510 回答
0

有一个冗长而繁琐的解决方法：首先记录没有任何成员的类，然后自己插入节标题，然后逐个记录成员。

使用来自https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html的类的示例，其中还说明了指令：

.. currentmodule:: module.name

Documentation
-------------

.. autoclass:: Noodle

Attributes
----------

.. autoattribute:: Noodle.eat
.. autoattribute:: Noodle.slurp
.. autoamethod:: Noodle.boil
于 2021-07-13T09:26:58.427 回答