python-Sphinx：模块中的功能列表

我有一些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 ：.我已经看过使用目录,但是似乎我需要为每个项目手动创建一个条目.我也查看了自动摘要,但仍然需要列出成员.有自动化的建议吗？我宁愿避免第三方扩展.

解决方法:

您可能想要像autosummary extension这样的东西.但是,实际的自动摘要扩展名并不能完全满足您的要求.

给出了如何扩展自动摘要以自动检测模块内容的示例in this answer

标签：python,python-sphinx
来源： https://codeday.me/bug/20191010/1887019.html