如何在 sphinx_rtd_theme 中将“查看页面源代码”替换为“在 GitHub 上编辑”链接？

Question

在使用

sphinx_rtd_theme

主题构建 Sphinx 网站时，如何将文档页面顶部的

View page source

超链接替换为 Edit on GitHub 链接？

我正在使用 GitHub Pages 手动构建一个类似 readthedocs.io 的网站，但我所有文档页面右上角的链接仍然显示“查看页面源代码”而不是“在 GitHub 上编辑”。

主题的文档列出了一些相关选项（display_github

、

vcs_pageview_mode

和

github_url

），但没有提供示例。我尝试将它们设置在 

conf.py

 的根部和 

html_theme_options

 中，但无济于事。

如何告诉

sphinx_rtd_theme

 主题将我所有文档页面上的 

View page source

 链接更改为 

Edit on GitHub

 链接？

Answer 1

您应该在

display_github

 中的 

github_user

 字典内设置 

github_repo

、

github_version

、

html_context 和 conf.py

 变量。对于

示例

：

html_context = {
  'display_github': True,
  'github_user': 'buskill',
  'github_repo': 'buskill-app',
  'github_version': 'master/docs/',
}

这些变量旨在直接在

.rst

文件中设置，而不是一般在

html_theme_options

 或 

conf.py

 中设置。要使其真正应用于站点范围，就像在 

every.rst 文件中定义一样，只需将其放入 html_context

 中。

另请参阅：

https://github.com/readthedocs/sphinx_rtd_theme/issues/529

• https://github.com/readthedocs/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/breadcrumbs.html