求助:如何移除ReadTheDocs站点上的「Edit on Github」选项
移除ReadTheDocs站点「Edit on Github」按钮的可行方案
方法1:修改Sphinx配置文件(conf.py)
- 在项目的
conf.py中添加或修改以下配置,关闭主题默认的源码链接展示:html_show_sourcelink = False - 若使用的是sphinx_rtd_theme,额外添加主题专属配置,清空VCS编辑链接的触发参数:
html_theme_options = { # 保留你原有主题配置的其他参数,新增或修改这一项 'vcs_pageview_mode': '', }
方法2:通过ReadTheDocs后台直接关闭
- 登录ReadTheDocs后台进入你的项目
- 点击「Admin」→「Advanced settings」
- 找到「Show "Edit on GitHub" link」选项,取消勾选后保存设置
解决你遇到的报错问题
你之前尝试的旧方案中html_context相关配置与当前主题/ReadTheDocs版本不兼容,建议先删除这些旧代码,再尝试上面的方法。如果仍有变量未定义的报错,检查conf.py中是否存在未赋值的冗余变量,直接清理即可。
验证修改
提交配置修改到仓库,触发ReadTheDocs重新构建,完成后刷新站点页面即可确认按钮已移除。
内容的提问来源于stack exchange,提问作者Sabry Superman
相关产品推荐
相关产品推荐

