我正在用 Sphinx 記錄我的 Python 項目。由于我的一些文檔頁面相當長，我希望在側邊欄中同時包含本地和全局目錄。我通過實現這一目標html_sidebars = { '**': ['localtoc.html', 'globaltoc.html', 'searchbox.html'] }結果幾乎符合預期。但是，本地目錄和全局目錄都具有相同的標題（“目錄”）。也就是說，它看起來像Table of Contents - Subheading 1 - Subheading 2 - Subheading 3Table of Contents - Subpage 1 - Subpage 2 - Subpage 3這讓讀者感到困惑。我已經localtoc.html在我的 Python 安裝的 sphinx 包文件夾中找到了該文件，并且根據我的需要調整 html（替換標題）很簡單。但是，我不想更改 Sphinx 源文件，并且通過 python 包構建我自己的主題對我來說似乎有點矯枉過正。有沒有辦法在 localtoc.html本地替換，即僅用于當前項目？
1 回答
holdtom
TA貢獻1805條經驗 獲得超10個贊
您可以覆蓋localtoc.html模板的行為。
_templates在您的 Sphinx 根目錄（與您的conf.py文件所在的位置相同）中創建一個文件夾，然后localtoc.html從您的 Sphinx 安裝復制到此文件夾。
然后，您可以根據需要修改此文件。刪除這一行：
<h3><a href="{{ pathto(master_doc) }}">{{ _('Table of Contents') }}</a></h3>擺脫多余的標題，或者您可以根據需要替換任何文本（例如更改<a>to的內容Local Contents或您喜歡的任何內容。
請注意，更改localtoc.html刪除兩個標題的頂部。如果這是你想要的，太好了！如果沒有，您可以globaltoc.html以相同的方式復制該過程。
添加回答
舉報
0/150
提交
取消