python - 在 Read The Docs 侧边栏中显示整个 toctree

Question

这是我对新的 Read The Docs 主题的理解 generates the sidebar from the toctree深度为2。我的文档比较深，深度2不够用。我怎样才能增加这个限制，或者最好完全删除它？

如果这不太可能，我如何使用本地目录而不是全局目录树？

Answer 1

注意:之前的回答已经过时了。正如@Ariel 在评论中指出的那样，maxdepth 现在可以通过在 html_theme_options 中设置 navigation_depth 进行配置。根据 README ，在你的项目的 conf.py 中改变这个:

html_theme_options = {
    'navigation_depth': 4,
}

---

查看 source for the theme on Github ，目录深度似乎是硬编码在 line 93 in sphinx_rtd_theme/layout.html 上的.因此，您无法对主题进行配置来覆盖它。

由于该行是硬编码的，您将始终获得 toctree 返回的全局目录树，而不是以下行“支持”的本地目录树。

当然，您可以 fork 主题并更改该行以供本地使用(您可以在 RTD 上使用自定义主题，因此也应该在那里工作)。我尝试使用演示主题这样做。 maxdepth=3 看起来像这样，因此可能需要一些额外的 CSS。 documentation for the toctree template function指定无限深度，只需传递 maxdepth=-1。请注意，这不会向 TOC 的子级别添加折叠/展开。

可能是一个很好的拉取请求目标？