这个问题是受Mayavi documentation启发的,它的漂亮分节符是每个模块成员之间描述的函数名称。

我的.rst现在看起来像:

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

    .. automodule:: ExperimentOrganizer.table_def
        :members:


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

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

提前致谢!

最佳答案

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


否。automodule或类似的东西没有神奇的选择。如果需要节标题,则必须将它们自己添加(也许通过使用脚本)到reST源。另请参见以下类似问题的答案:Sphinx customizing autoclass output

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

10-02 10:37