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

编程问答 2022-05-25

问题描述

我正在使用 read the docs 主题使用 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. 还有，主题里有没有变量指定分支名？

解决方法

您可以使用配置值 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 源。

,

我添加了

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

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

htmlpython-sphinxread-the-docs