阅读文档主题 - 使用 Sphinx 更改“在 github 上编辑”链接答案

【问题标题】：Read the Docs theme - change the "Edit on github" link using Sphinx阅读文档主题 - 使用 Sphinx 更改“在 github 上编辑”链接
【发布时间】：2021-02-16 15:34:42
【问题描述】：

我正在使用read the docs 主题来使用 sphinx 创建 HTML 内容。在主题中，我想编辑“在 Github 上编辑”部分的超链接。我可以使用 conf.py 文件中的以下变量启用或禁用链接。

html_context = {
    'display_github': True,
    'github_repo': 'xyz',
               }`

这导致以下链接https://github.com/xyz

但是，我们公司有一个内部 GitLab 存储库，我想将链接更改为 https://github.companyname.com/xyz
另外，主题中是否有一个变量来指定分支名称？

【问题讨论】：

欢迎来到 Stack Overflow。如果答案解决了您的问题，您应该在答案左侧accept it by clicking the green check mark。请参阅this meta thread 中的完整说明。

标签： html python-sphinx read-the-docs

【解决方案1】：

您可以使用配置值github_url 强制“在 GitHub 上编辑”按钮使用配置的 URL。

github_url = "https://github.companyname.com/xyz"

如果这是您在第二个问题中的意思，您可以配置 RTD 以发布文档的不同分支。我们为 Pyramid 这样做。

如果您指的是 GitHub URL，则没有其他特殊变量可将分支包含在“在 GitHub 上编辑”按钮的 URL 中。您可以在每个分支的 conf.py 中手动为 github_url 执行此操作，例如在 my-branch 分支上：

github_url = "https://github.companyname.com/my-branch/xyz"

然后当分支在 RTD 上发布时，每个分支都会有自己的链接到该分支的 reST 源。

【讨论】：

【解决方案2】：

我加了

rst_prolog = """
:github_url: https://github.com/torvalds/linux
"""

在 conf.py 中更改每个页面上 Edit On GitHub 按钮的链接

【讨论】：

对我来说，这只是让 Github 上的编辑页面转到所有页面的一个静态 URL，而不是当前页面的 github 版本。