如何在每个页面的侧边栏中包含toctree [英] How to include the toctree in the sidebar of each page

问题描述

我正在使用Sphinx生成html文档。

如何修改文档中每个html页面的侧栏，使其包含toctree？默认情况下，目录树似乎只显示在master_doc页面中，并且只显示在主区域，而不是侧边栏。

有什么简单的方法可以做到这一点吗？我将使用ReadtheDocs来托管生成的文档，因此我倾向于避免使用任何第三方插件，除非它们在ReadtheDocs上也可用。

推荐答案

您可以在conf.py中自定义您的html侧边栏。

默认html侧边栏包含4个模板：

['localtoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html']

在conf.py中，您可以将localtoc.html更改为global altoc.html，如下所示：

html_sidebars = { '**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'] }

因为这最终将在HTML文件中使用，所以这应该适用于ReadTheDocs。

这篇关于如何在每个页面的侧边栏中包含toctree的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！