python - 可以告诉 Sphinx "automodule"在成员之间自动插入分节符吗？

Question

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

我的 .rst 现在看起来像:

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

.. automodule:: ExperimentOrganizer.table_def
    :members:

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

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

Answer 1

Can the Sphinx "automodule" be told to automatically insert section breaks between members?

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

Mayavi documentation您所指的不是用 autodoc 创建的.这些函数使用 function 记录。指令(不是 autofunction)。单击“显示源”以查看 reST 标记。