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

par*_*iso 5 python restructuredtext sections python-sphinx autodoc

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

.rst现在看起来像:

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

.. automodule:: ExperimentOrganizer.table_def
    :members:
Run Code Online (Sandbox Code Playgroud)

(包含模块本身中的所有文档格式文本。)

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

mzj*_*zjn 4

Sphinx“自动模块”是否可以被告知在成员之间自动插入分节符?

不,没有什么神奇的选择automodule或类似的东西。如果您想要节标题,那么您必须自己将它们(可能通过使用脚本)添加到 reST 源中。另请参阅此类似问题的答案:Sphinx 自定义自动类输出

您引用的Mayavi 文档不是使用autodoc创建的。这些函数是使用function指令(而不是autofunction)来记录的。单击“显示源”以查看其余标记。