python - 在 Read The Docs 侧边栏中显示整个目录树

Question

据我了解，新的 Read The Docs 主题从深度为 2 的目录树生成侧边栏。我的文档相对较深，深度为 2 不足以使其有用。我怎样才能增加这个限制，或者最好完全删除它？

如果这不合理，我如何使用本地 ToC 而不是全局目录树？

Answer 1

注意：以前的答案已过时。正如@Ariel 在评论中指出的那样，maxdepth现在可以通过设置navigation_depthin来配置html_theme_options. 根据README，在项目的 conf.py 中进行更改：

html_theme_options = {
    'navigation_depth': 4,
}

---

查看Github 上主题的源代码，似乎 ToC 深度在 sphinx_rtd_theme/layout.html 的第 93 行是硬编码的。因此，您无法对主题进行配置来覆盖它。

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

当然，您可以分叉主题并更改该行以供本地使用（并且您可以在 RTD 上使用自定义主题，因此也应该在那里工作）。我尝试使用演示主题这样做。它看起来像这样maxdepth=3，因此可能需要一些额外的 CSS。模板函数的文档toctree指定对于无限深度，只需传递maxdepth=-1. 请注意，这不会将折叠/展开添加到 TOC 的子级别。

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

Answer 2

至少在 ReadTheDocs 中无法自定义此行为。但是，您仍然可以阅读页面中的附加细节层——它们只是不会显示在导航中。