显示整个toctree在阅读文档边栏

这是我的理解深度为2的新的阅读文档主题generates the sidebar from the toctree。我的文档相对较深，深度为2是不够的，它是有用的。我该如何增加这个限制，或者最好完全删除它？显示整个toctree在阅读文档边栏

如果这样做不合理，我该如何使用本地ToC而不是全局的toctree？

来源

2014-12-27 Kevin

注：上一个答案已过时。正如@Ariel在评论中指出的那样，maxdepth现在可通过在html_theme_options中设置navigation_depth来配置。由于每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返回的全局toctree，而不是由以下行“支持”的本地onectree。

当然，您可以为主题分叉主题并更改该行（并且您可以在RTD上使用自定义主题，因此也应该在其中工作）。我尝试了演示主题。它看起来像maxdepth=3，所以可能需要一些额外的CSS。 documentation for the toctree template function规定对于无限深度，只需通过maxdepth=-1即可。请注意，这不会为TOC的子级添加折叠/展开。

可能是拉请求的好目标？

Demo theme with tocdepth=3

来源

2015-01-04 15:39:21 vicvicvic

这不是一个2级以上的边栏吗？ http://read-the-docs.readthedocs.org/en/latest/getting_started.html我该如何模仿这种行为？它只显示多个层次，当我有一个子项目的项目，但这对我来说足够好。 – Ariel 2015-12-08 07:55:17

好的，我在版本0.1.6，显然他们在版本0.1.8中添加了对深度3和4的支持：https://github.com/snide/sphinx_rtd_theme#v0-1-8 – Ariel 2015-12-08 08:30:21

这是否适用于在线RTD版本？它似乎只对我本地工作，请参阅[对Github上的相应问题]（https://github.com/rtfd/readthedocs.org/issues/2718） – 2017-03-11 04:55:52

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

来源

2015-01-03 01:18:33 felixphew

显示整个toctree在阅读文档边栏

回答

相关问题