Python 在Sphinx文档的侧栏中显示所有公共函数的列表
我该如何将“公共”功能的项目符号列表添加到用Sphinx记录的项目侧栏中 例如,假设我有一个模块api.py,具有以下函数:Python 在Sphinx文档的侧栏中显示所有公共函数的列表,python,python-sphinx,Python,Python Sphinx,我该如何将“公共”功能的项目符号列表添加到用Sphinx记录的项目侧栏中 例如,假设我有一个模块api.py,具有以下函数: 职能1() 职能2() 职能3() 我希望在文档的侧栏中有一个指向函数1、函数2和函数3的链接的项目符号列表。这些链接将链接到使用:automodule:api记录的此函数的页面。因此,每个侧边栏链接只会链接到该函数的自动文档信息 我尝试过使用内置的autosummary扩展和fulltoc扩展,但我无法让他们使用我尝试过的随机配置选项来实现这一点 我认为这可能需要制
- 职能1()
- 职能2()
- 职能3()
:automodule:api
记录的此函数的页面。因此,每个侧边栏链接只会链接到该函数的自动文档信息
我尝试过使用内置的autosummary
扩展和fulltoc
扩展,但我无法让他们使用我尝试过的随机配置选项来实现这一点
我认为这可能需要制作一个自定义的sidebar.html模板。但是,如何在Jinja模板中获得模块中的所有函数的列表
老实说,我不介意硬编码一个自定义模板,我必须手动列出函数和链接,但我不知道如何设置每个项目上的href
,以直接指向该函数的自动文档信息