Naa*_*tan 7 python documentation documentation-generation python-sphinx read-the-docs
我正在尝试使用sphinx来记录文档的多个"级别",例如:
我们的想法是,目录栏显示在侧栏上,相对于您所在的部分.因此,当您在主索引上时,它只显示上面提到的部分.当你进入eg."手动"它显示了该部分特定的不同ToC,以及返回主ToC的方法.
我一直试图弄清楚如何让它在Sphinx中工作而不会入侵它,但到目前为止还不能找到方法.文件夹结构已经反映了不同的部分(即所有"手动"文档存储在_source/manual下),我尝试在每个目录中放置单独的索引文件,但似乎toctree功能只查看主索引文件.
我正在使用"readthedocs"主题,我正在特别关注的代码是https://github.com/snide/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/layout.html#L93
谁能告诉我如何使用Sphinx添加像这样的ToC?
谢谢
看起来.. toctree::子目录中的文档中的 a 植根于该子目录(参见例如https://docs.python.org/2/_sources/howto/index.txt)。对于上层 TOC,:maxdepth:限制包含下层 TOC。
可以通过制作相应的模板并将其添加到 更新:不起作用;在侧边栏模板中,TOC 的根始终位于顶部。html_sidebars构建参数来将其放置到侧边栏中。