readthedocs/sphinx_rtd_theme

Global setting for disabling "Edit button"

Open

#1,366 创建于 2022年11月1日

在 GitHub 查看
 (0 评论) (1 反应) (0 负责人)CSS (3,473 star) (1,413 fork)batch import
FeatureGood First IssueImprovement

描述

People are having issues figuring out how to remove the "Edit on Github" button, and I would agree that it's cumbersome.

I don't think it's a good idea to remove it, but I'm sure people have their reasons.

The most straight-forward solution would probably be to respect the html_show_sourcelink setting.

See also: https://github.com/sphinx-doc/sphinx/issues/2386

贡献者指南

技术栈
pythoncsshtml
领域
documentationfrontend
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
Familiarity with Sphinx theme configurationUnderstanding of Sphinx templating
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
65
研究方向
Investigate the theme's template files, likely `layout.html` or similar, to locate where the 'Edit on GitHub' button is rendered. Then look at how other settings like `html show sourcelink` are implemented in Sphinx's core and the theme to add a similar global toggle. The linked issue #2386 provides additional context on the setting's behavior.