Sphinx:模块中的函数列表

本教程将介绍Sphinx:模块中的函数列表的处理方法,这篇教程是从别的地方看到的,然后加了一些国外程序员的疑问与解答,希望能对你有所帮助,好了,下面开始学习吧。

Sphinx:模块中的函数列表 教程 第1张

问题描述

我有一些包含大部分函数和一些类的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:模块中的函数列表的教程就到这里就结束了,希望趣模板源码网找到的这篇技术文章能帮助到大家,更多技术教程可以在站内搜索。