使用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选项现在除去。