Sphinx：模块中的函数列表 [英] Sphinx: list of functions in a module

问题描述

我有一些包含大部分函数和一些类的Python模块。在单独的rst中使用sphinx-audoc.记录了每一种情况。我想要做的是在每个页面的顶部创建一个模块内容的表或列表，例如，mymode.py的

def first():
    'First function'

def second():
    'Second function'

和mymode.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 extension。但是，实际的自动摘要扩展并不能完全满足您的要求。

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

这篇关于Sphinx：模块中的函数列表的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！