Toctree在Python的狮身人面像的多层次

Question

我试图使用狮身人面像的方式来记录文档的多个“级别”，例如：

• API参考
• 手册
• 教程
• 等

这个想法是，内容列表显示在侧栏相对于你所在的部分。所以，当你在主索引它o nly显示了上面提到的部分。当你进入例如。 “手动”它显示了特定于该部分的不同ToC，以及返回主ToC的方式。

我一直在试图弄清楚如何在没有黑客入侵的情况下在Sphinx中工作，但到目前为止还不能完全弄清楚方式。文件夹结构已经反映了不同的部分（即所有的“手动”文档存储在_source/manual下），我试过在每个目录中放置单独的索引文件，但似乎toctree功能只看主索引文件。

我现在用的是“readthedocs”的主题，代码我看着特别是https://github.com/snide/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/layout.html#L93

谁能告诉我，我怎么会去加入这样的狮身人面像使用通过TOC？

谢谢

Answer 1

看来，在一个子目录中的文件内的.. toctree::在该子目录是植根（见例如https://docs.python.org/2/_sources/howto/index.txt）。对于上层TOC，:maxdepth:限制了较低层次的包含。

这可以通过制作相应的模板并将其添加到html_sidebars构建参数来放入侧边栏。更新：不起作用;在侧边栏模板中，TOC始终位于顶部。

Answer 2

（也许迟到这种反应有点） 我和你类似的情况，我已经包含在同一TOC树三个部分：

• 硬件
• 软件
• 教程

我正在试图达到和你一样的隐藏我的边栏菜单的所有不属于当前toctree-l1的东西。明知狮身人面像添加CSS类“当前”，我想出了：

#sidebar li.toctree-l1:not(.current){ 
    display: none; 
} 

这不是最好的解决方案不断，但由于狮身人面像可以只处理一个主要的根文件，并从它创建的整个TOC树，如果你只需要它的边栏菜单，CSS可以为你工作。

截图我的菜单只是显示下方一个部分的内容：