在“阅读文档”侧栏中显示整个toctree

Question

我理解新的Read The Docs主题generates the sidebar from the toctree，深度为2.我的文档相对较深，深度为2并不足以使其有用。如何增加此限制，或者最好将其完全删除？

如果这不合理，我怎样才能使用本地ToC而不是全局toctree？

Answer 1

注意：之前的回答已过时。正如@Ariel在评论中指出的那样，现在可以通过在maxdepth中设置navigation_depth来配置html_theme_options。根据{{​​3}}，在项目的conf.py中更改此内容：

html_theme_options = {
    'navigation_depth': 4,
}

---

查看README，似乎ToC深度在source for the theme on Github上是硬编码的。因此，您无法对主题进行任何配置以覆盖它。

由于该行是硬编码的，因此您将始终获得toctree返回的全局toctree，而不是本地的toctree＆＃34;支持＆＃34;通过以下几行。

当然，您可以分叉主题并更改该行以供本地使用（并且您可以在RTD上使用自定义主题，因此也应该在那里工作）。我尝试使用演示主题。使用maxdepth=3看起来像这样，因此可能需要一些额外的CSS。 line 93 in sphinx_rtd_theme/layout.html指定无限深度，只需传递maxdepth=-1即可。请注意，这不会将崩溃/扩展添加到TOC的子级别。

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

Answer 2

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