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 (1,413 forks)batch import
FeatureGood First IssueImprovement

Repository metrics

Stars
 (3,473 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Investigate the `html show sourcelink` setting and add a conditional check to hide the edit button based on that setting.
Tech stack
csspython
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75