Python中Toctree的多个级别

2018-06-30 03:37:28

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

Api参考

手册

教程

等等。

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

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

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

任何人都可以告诉我如何使用狮身人面像添加一个像这样的ToC？

谢谢

（也许这个回应迟了一点）我的情况与你的相似，我有三个部分包含在同一个TOC树中：

硬件

软件

教程

我试图实现与隐藏在我的边栏菜单中的所有不属于当前toctree-l的所有内容。知道狮身人面像添加CSS类'当前'我想出了：

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

这不是有史以来最好的解决方案，但由于Sphinx可以处理文档的一个主要根目录，因此它会创建整个TOC树，如果您只需要侧栏菜单，CSS就可以为您工作。

我的菜单屏幕截图只显示了一个部分下面的内容：

看起来，子目录中的文档中的.. toctree::根植于该子目录中（请参阅https://docs.python.org/2/_sources/howto/index.txt）。对于上层TOC， :maxdepth:限制包含较低层次。

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

链接地址: http://www.djcxy.com/p/84127.html