Sphinx：模块中的函数列表

Question

我有一些python模块，主要包含函数和几个类。 每个人都使用sphinx-autodoc在一个单独的rst中记录。 我想要做的是在每个页面的顶部创建一个表或模块的内容列表，例如，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，但似乎我需要为每个项目手动创建一个条目。 我也看过autosummary，但我仍然需要列出成员。 有任何关于自动化的建议吗？ 我宁愿避免第三方扩展。

Answer 1

你可能想要像 autosummary扩展 这样的东西。 但是，实际的自动扩展扩展并不会完全符合您的要求。

本答案中给出了如何扩展自动总结以自动检测模块内容的示例