2017-10-19 48 views
1

我已經瞭解到,可以通過多個文件by using the include command將部分/章節等文檔保存爲模塊形式。如何保留Sphinx中的部分/章節結構而不創建單個長頁面?

這種方法唯一的問題是,它有效地將所有包含的文件連接成一個大文件,這意味着它們不再被Sphinx Read The Docs theme視爲單獨的頁面。

由於這一結果,文檔有用戶需要向下滾動,而不是previous/next按鈕導航短的網頁很長頁面。我希望我的文檔具有後一種結構,因爲我認爲它創建了更舒適的用戶體驗。

如何在不創建單個長頁的情況下保留部分/章節結構?

+0

這就是'toctree'的用途。 http://www.sphinx-doc.org/en/stable/markup/toctree.html – mzjn

+0

嗨@mzjn,謝謝你的評論。我已經閱讀了關於'toctree'的文檔,並且知道如何使用它,但我不確定當你說'這就是'toctree'是'的時候我知道你的意思。你能否在完整答案中詳細說明你的評論? – AZD

+0

我不明白問題所在。 toctree可以用來「保留部分/章節結構而不創建一個單獨的,長的頁面」。 – mzjn

回答

0

立足自己在前面的問題,你參考,我應該提醒你注意的是給予有以上的解決方案,以便對問題本身:-)

你的文件沒有正確地再現標題(「部分「反對」章節),因爲toctree指令認爲被包含文檔中的第一個標題是該文檔的「首要標題」。另一種解決方案是在主文件中使用toctree指令移動

###### 
Part 1 
###### 

部分。

###### 
Part 1 
###### 

.. toctree:: 
    :maxdepth: 2 

    test1 
    test2 

我通過經驗瞭解到了這一點。不過,我找不到合適的參考。

相關問題