Toctree在Python的獅身人面像的多層次

Question

我試圖使用獅身人面像的方式來記錄文檔的多個「級別」，例如：

• API參考
• 手冊
• 教程
• 等

這個想法是，內容列表顯示在側欄相對於你所在的部分。所以，當你在主索引它o nly顯示了上面提到的部分。當你進入例如。 「手動」它顯示了特定於該部分的不同ToC，以及返回主ToC的方式。

我一直在試圖弄清楚如何在沒有黑客入侵的情況下在Sphinx中工作，但到目前爲止還不能完全弄清楚方式。文件夾結構已經反映了不同的部分（即所有的「手動」文檔存儲在_source/manual下），我試過在每個目錄中放置單獨的索引文件，但似乎toctree功能只看主索引文件。

我現在用的是「readthedocs」的主題，代碼我看着特別是https://github.com/snide/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/layout.html#L93

誰能告訴我，我怎麼會去加入這樣的獅身人面像使用通過TOC？

謝謝

Answer 1

看來，在一個子目錄中的文件內的.. toctree::在該子目錄是植根（見例如https://docs.python.org/2/_sources/howto/index.txt）。對於上層TOC，:maxdepth:限制了較低層次的包含。

這可以通過製作相應的模板並將其添加到html_sidebars構建參數來放入側邊欄。更新：不起作用;在側邊欄模板中，TOC始終位於頂部。

Answer 2

（也許遲到這種反應有點） 我和你類似的情況，我已經包含在同一TOC樹三個部分：

• 硬件
• 軟件
• 教程

我正在試圖達到和你一樣的隱藏我的邊欄菜單的所有不屬於當前toctree-l1的東西。明知獅身人面像添加CSS類「當前」，我想出了：

#sidebar li.toctree-l1:not(.current){ 
    display: none; 
} 

這不是最好的解決方案不斷，但由於獅身人面像可以只處理一個主要的根文件，並從它創建的整個TOC樹，如果你只需要它的邊欄菜單，CSS可以爲你工作。

截圖我的菜單只是顯示下方一個部分的內容：