在“读取文档”侧b中显示整个目录树

Question

这是我对新的Read the Docs主题generates the sidebar from the toctree的理解，深度为2。我的文档比较深，深度2还不足以让它有用。我怎样才能提高这个限制，或者最好完全取消它？

如果这不太可能，我如何使用本地ToC而不是全局toctree？

Answer 1

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

Answer 2

注意：前面的答案已经过时。正如@Ariel在注释中指出的，现在可以通过在html_theme_options中设置navigation_depth来配置maxdepth。根据README，在项目的conf.py中更改此项：

html_theme_options = {
    'navigation_depth': 4,
}

---

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

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

当然，您可以分叉主题并更改该行以供本地使用（而且您可以在RTD上使用自定义主题，因此也应该在RTD上工作）。我试着用演示主题。在maxdepth=3中看起来是这样，因此可能需要一些额外的CSS。documentation for the ^{} template function指定对于无限深度，只需传递maxdepth=-1。请注意，这不会将折叠/展开添加到目录的子级。

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