使用ReadTheDocs主题阅读Docs&Sphinx时删除Github上的编辑链接

Bri*_*ing 3 python-sphinx read-the-docs

我试图找出如何使用Sphinx中的_template覆盖选项覆盖默认的ReadTheDocs主题,以便在http://readthedocs.org上托管Sphinx文档.

具体来说,我想要删除/隐藏此主题右上角显示的"在Github上编辑"链接.

任何提示将非常感谢!谢谢!

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

谢谢!

Bri*_*ing 8

好吧,我想通了,所以我会回答我自己的询问,希望能帮助别人.

假设您正在使用ReadTheDocs默认主题,这应该可以正常工作.

  • 将ReadTheDocs主题从Github repo克隆到您的计算机.(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文件添加到文件夹中的Sphinx文档文件_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仓库
  • 利润

参考