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

Question

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

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

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

1. 但是，我们公司有一个内部 GitLab 存储库，我想将链接更改为https://github.companyname.com/xyz

2. 另外，主题中是否有一个变量来指定分支名称？

标签： htmlpython-sphinxread-the-docs

Answer 1

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

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

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

• https://docs.pylonsproject.org/projects/pyramid/en/master/
• https://docs.pylonsproject.org/projects/pyramid/en/1.10-branch/

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

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

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