将 Read The Docs 和 Sphinx 与 ReadTheDocs 主题一起使用时删除 Github 上的编辑链接答案

【问题标题】：Removing the Edit on Github link when using Read The Docs & Sphinx with ReadTheDocs Theme将 Read The Docs 和 Sphinx 与 ReadTheDocs 主题一起使用时删除 Github 上的编辑链接
【发布时间】：2016-03-15 18:49:48
【问题描述】：

我正在尝试了解如何使用 Sphinx 中的 _template overrides 选项来覆盖默认的 ReadTheDocs 主题，以便在 http://readthedocs.org 上托管 Sphinx 文档。

具体来说，我想删除/隐藏此主题右上角显示的“在 Github 上编辑”链接。

任何提示将不胜感激！谢谢！

我在这里查看了文档：http://www.sphinx-doc.org/en/stable/templating.html，但是，我很困惑，真的需要一些帮助。

谢谢！

【问题讨论】：

标签： python-sphinx read-the-docs

【解决方案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 文件夹中的Sphinx 文档文件夹中。 如果此目录尚不存在，则需要创建它。
在您的conf.py 文件中找到您的html_context 部分，如果您还没有这个，您可以创建它。（示例链接如下）。

html_context = { "display_github": False, # Add 'Edit on Github' link instead of 'View page source' "last_updated": True, "commit": False, }
使用Git将breadcrumbs.html文件添加到您跟踪的文件中
将更改提交到您的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 选项现已删除。

【讨论】：

【解决方案2】：

阅读文档文档有类似的说明：https://docs.readthedocs.io/en/latest/guides/remove-edit-buttons.html#。因此，自发布原始答案以来，可能已经发生了基础代码更改。

【讨论】：

【解决方案3】：

我的需求非常相似，但并不完全相同。我想删除生成页面的这个链接（“搜索”和“genindex”），并更改链接文本，因为我们使用 framagit 作为项目托管。

这是我最后的版本：

{%- extends "sphinx_rtd_theme/breadcrumbs.html" %}

{% block breadcrumbs_aside %}
  <li class="wy-breadcrumbs-aside">
    {% if hasdoc(pagename) and pagename != "search" and pagename != "genindex" %}
      <a href="{{ meta['framagit_url'] }}" class="fa fa-bitbucket"> {{ _('Edit on FramaGit') }}</a>
    {% endif %}
  </li>
{% endblock %}

在这里现场观看： https://framagit.org/simgrid/simgrid/tree/master/docs/source

【讨论】：