如何在自托管GitLab实例上为Sphinx文档添加「编辑源代码」按钮？

要在自托管GitLab实例上实现Sphinx文档的「编辑源代码」按钮，只需在原有公开GitLab的配置基础上，新增gitlab_url字段指定你的自托管实例地址即可，完整配置如下：

html_context = {
    "display_gitlab": True,  # 开启GitLab集成功能
    "gitlab_url": "https://your-self-hosted-gitlab-domain.com",  # 替换为你的自托管GitLab实例完整地址
    "gitlab_user": "MyUserName",  # GitLab用户名或组名
    "gitlab_repo": "MyDoc",  # 文档所在仓库名称
    "gitlab_version": "master",  # 要关联的分支或tag版本
    "conf_py_path": "/source/",  # 仓库中docs源码根目录的路径
}

关键配置说明： #

• gitlab_url：必须填写自托管GitLab实例的根地址，比如https://gitlab.yourcompany.com，如果实例使用非标准HTTPS/HTTP端口，也要一并带上（如https://gitlab.yourcompany.com:8443）
• 若文档仓库属于GitLab组而非个人账号，gitlab_user直接填写组名即可
• conf_py_path要和仓库中实际的文档源码路径匹配，开头的斜杠可加可不加，写成source/也能正常生效

内容的提问来源于stack exchange，提问作者Krishna