readthedocs/sphinx_rtd_theme

Global setting for disabling "Edit button"

Open

#1,366 opened on Nov 1, 2022

View on GitHub
 (0 comments) (1 reaction) (0 assignees)CSS (3,473 stars) (1,413 forks)batch import
FeatureGood First IssueImprovement

Description

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

Contributor guide

Tech stack
pythoncsshtml
Domain
documentationfrontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Familiarity with Sphinx theme configurationUnderstanding of Sphinx templating
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
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.