在侧边栏中显示所有公共功能的Sphinx文档列表

dur*_*2.0 5 python python-sphinx

我该如何将“公共”功能的项目符号列表添加到使用Sphinx记录的项目的边栏中?

例如,假设我有一个具有以下功能的模块api.py:

  • function1()
  • function2()
  • function3()

我想在文档的边栏中有一个指向项目1,函数2和函数3的链接的项目符号列表。这些链接将链接到使用记录的此功能页面:automodule: api。因此,每个侧边栏链接只会链接到该功能上自动记录的信息。

我尝试使用内置autosummary扩展名和fulltoc扩展名,但是我无法让他们使用我尝试的随机配置选项来做到这一点。

我认为这可能需要制作自定义sidebar.html模板。但是,如何获得Jinja模板中模块的所有功能的清单?

老实说,我不会介意硬编码一个自定义模板,在该模板中我不得不手动列出该函数和链接,但是我不知道如何href在每个项目上将其设置为直接指向自动文档化的函数信息。