gpt4 book ai didi

python - Python-Sphinx 中的多级 Toctree

转载 作者:太空狗 更新时间:2023-10-29 21:58:31 26 4
gpt4 key购买 nike

我正在尝试使用 sphinx 来记录多个“级别”的文档,例如:

  • API 引用
  • 手册
  • 教程

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

我一直在尝试弄清楚如何在不侵入 Sphinx 的情况下让它在 Sphinx 中工作,但到目前为止还没有完全找到办法。文件夹结构已经反射(reflect)了不同的部分(即所有“手册”文档都存储在 _source/manual 下)并且我尝试在每个目录中放置单独的索引文件,但似乎 toctree 功能只查看主索引文件。

我正在使用“readthedocs”主题,我正在查看的具体代码是https://github.com/snide/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/layout.html#L93

谁能告诉我如何使用 Sphinx 添加这样的目录?

谢谢

最佳答案

(这个回复可能有点晚了)我有类似的情况,同一 TOC 树中包含三个部分:

  • 硬件
  • 软件
  • 教程

我试图实现相同的目标,即从我的侧边栏菜单中隐藏所有不属于当前 toctree-l1 的内容。知道 Sphinx 添加了我想出的 CSS 类“current”:

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

这不是有史以来最好的解决方案,但由于 Sphinx 只能处理文档的一个主根,并且从那个主根创建整个 TOC 树,如果您只需要侧边栏菜单,CSS 应该适合您.

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

关于python - Python-Sphinx 中的多级 Toctree,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/25693324/

26 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com