狮身人面像:模块中的功能列表

我有一些包含大部分函数和几个类的python模块。 每一个都使用sphinx-autodoc单独记录。 我想要做的是在每个页面顶部创建一个表或模块内容列表,例如,mymodule.py的内容是

def first():
    'First function'

def second():
    'Second function'

而mymodule.rst是

Page Contents
-------------

:create_page_contents_list:

Members
-------

.. automodule:: mymodule
    :members:

然后输出应该看起来像这样:

Page Contents
-------------

first
second

Members
-------

first()
    First function

second()
    Second function

这个问题该怎么做:create_page_contents_list: 我看过使用TOC,但似乎需要为每个项目手动创建一个条目。 我也看过自动摘要,但我仍然需要列出成员。 有关自动化的任何建议? 我宁愿避免第三方扩展。


你可能想要像自动摘要扩展。 不过,实际的自动摘要扩展并不完全符合你的要求。

本答案给出了一个如何扩展自动摘要以自动检测模块内容的例子

链接地址: http://www.djcxy.com/p/84119.html

上一篇: Sphinx: list of functions in a module

下一篇: Horizonal LinearLayouts in a Vertical LinearLayout