在Sphinx HTML生成器中限制侧栏TOC深度

Question

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

Answer 1

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

:tocdepth: <n> 

<n>是你想要的深度。

Answer 2

我已经通过在_template/layout.html中设置主题定制中的maxdepth来看到最好的侧边栏结果。在rst toctree文件层次结构中不需要额外的指令选项。

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