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

Question

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

我的。现在只是看起来像：

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

    .. automodule:: ExperimentOrganizer.table_def
        :members:

（模块中的所有文档格式化文本）

是否有一种简单的方法来表明我希望在每个成员之间插入节标题：成员：？如果没有，玛雅维人是怎么做到的？

提前致谢！

Answer 1

  

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

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

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

Answer 2

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

使用 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