我正在 Sphinx 中生成 html 文档。
如何修改文档中每个 html 页面的侧边栏,以便它们包含目录树?默认情况下,目录树似乎只显示在master_doc
页面,并且仅在主区域而不是侧边栏。
是否有捷径可寻?我将使用 readthedocs 来托管生成的文档,因此我宁愿避免使用任何第三方插件,除非它们也可以在 readthedocs 上使用。
您可以自定义 html 侧边栏conf.py
.
默认的 html 侧边栏由 4 个模板组成:
['localtoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html']
In conf.py
您可以将 localtoc.html 更改为 globaltoc.html,如下所示:
html_sidebars = { '**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'] }
由于这最终将在 HTML 文件中使用,因此这应该适用于 ReadTheDocs。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)