Sphinx 索引

Sphinx 在构建文档时会生成名为 genindex、modindex 和 py-modindex 的索引。有关它们的更多信息可以在 Sphinx 索引文档 中找到。

添加索引链接

根据设计，使用此主题生成的文档中未链接索引页面。要将它们包含在每个页面的主侧边栏中，请将以下配置添加到 conf.py 文件中的 html_theme_options 中，可用的索引将显示在底部。

html_theme_options = {
    #[...]
    "primary_sidebar_end": ["indices.html", "sidebar-ethical-ads.html"]
    #[...]
}

备注

如果您使用 ReadTheDocs 托管文档，请不要忘记添加回 "sidebar-ethical-ads.html" 模板。