在Sphinx HTML构建器中限制侧边栏TOC深度

Question

我正在尝试限制Sphinx HTML Biulder生成的侧边栏toc的深度。我尝试用自己的方法更改localsidebar.html，但我在documentation中找不到任何提示，只是已弃用的选项。 {{ toc }}包含呈现的本地toc，但在呈现之前没有关于如何使用它的信息。

Answer 1

尝试将以下行放在文件顶部：

:tocdepth: <n> 

<n>是您想要的深度。

Answer 2

通过在_templates / layout.html中的主题自定义中设置maxdepth，我看到了最好的侧边栏结果。第一个toctree文件层次结构中不需要额外的指令选项。

{%- block sidebartoc %}
    {{ toctree(collapse=False,maxdepth=2) }}
{%- endblock %}