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

Question

我的理解是新的Read The Docs主题从toctree生成侧边栏,深度为2.我的文档相对较深,深度为2并不足以使其有用.如何增加此限制,或者最好将其完全删除？

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

Answer 1

注意:之前的答案已过时.正如@Ariel在评论中指出的那样,maxdepth现在可以通过设置navigation_depth来配置html_theme_options.根据README,在项目的conf.py中更改它:

html_theme_options = {
    'navigation_depth': 4,
}

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

由于该行是硬编码的,因此您将始终获得返回的全局toctree toctree,而不是由以下行"支持"的本地toctree .

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

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