显示侧栏中所有公共函数的列表,以供Sphinx文档使用

时间:2014-02-26 18:15:14

标签: python python-sphinx

我如何在Sphinx记录的项目的侧边栏中添加项目符号的“公共”功能列表?

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

  • 功能1()
  • 函数2()
  • 功能3()

我想在文档的侧边栏中有一个项目符号列表,其中包含function1,function2和function3的链接。这些链接将链接到使用:automodule: api记录的此功能的页面。因此,每个侧边栏链接只链接到该功能的autodoc信息。

我已尝试使用内置的autosummary扩展程序和fulltoc扩展程序,但我无法通过我尝试的随机分配配置选项来执行此操作。

我认为这可能需要制作自定义sidebar.html模板。但是,如何在Jinja模板中获取模块中所有函数的列表?

老实说,我不介意只是硬编码自定义模板,我必须手动列出功能和链接,但我无法弄清楚如何将每个项目的href设置为直接指向autodoc的信息。

0 个答案:

没有答案