使用ReadTheDocs主題刪除在Github上的編輯使用ReadTheDocs主題

Question

我想了解如何使用Sphinx中的_template覆蓋選項來覆蓋默認的ReadTheDocs主題以便在http://readthedocs.org上託管Sphinx文檔。

具體來說，我想要移除/隱藏此主題右上角顯示的「編輯Github」鏈接。

任何提示將不勝感激！謝謝！

我已閱讀文檔：http://www.sphinx-doc.org/en/stable/templating.html，但是，我很難過，真的需要一些幫助。

謝謝！

Answer 1

好的，我想通了，所以我會回答我自己的詢問，希望能幫助別人。

假設您使用ReadTheDocs默認主題，這應該工作得很好。

• 將ReadTheDocs主題從Github回購克隆到您的計算機。 （https://github.com/snide/sphinx_rtd_theme/）
• 找到breadcrumbs.html文件（https://github.com/snide/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/breadcrumbs.html）
• 添加breadcrumbs.html文件到您的獅身人面像文檔文件夾中的文件夾_templates。 如果此目錄尚不存在，您需要創建它。

• 在您的conf.py文件中找到您的html_context部分，如果您尚未有此部分，則可以創建它。 （以下鏈接樣本）。

  html_context = { "display_github": False, # Add 'Edit on Github' link instead of 'View page source' "last_updated": True, "commit": False, }

• 的breadcrumbs.html文件添加到您的跟蹤文件使用Git

• 提交更改到您的conf.py
• 推送到遠程GitHub庫
• 利潤

參考

• https://github.com/duelingdogs/dueling-docs/blob/master/source/conf.py#L36-L40
• http://help.duelingdogs.net/en/latest/（實施例示出的是，Edit on Github選項現在除去。