顯示整個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在閱讀文檔邊欄

回答

相關問題