Fix "Edit Page" button visibility on stable branches #20562
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
daksh1403
force-pushed
the
fix/docs-edit-button
branch
from
db3c671 to
a5b166b
Compare
Collaborator
|
Release branches do not receive any updates, they are carved in stone, so why should "edit page" link to branches other than master? User-visible 404 errors are bad, but receiving PRs against release branches for a file that no longer exists would be no less awkward. Hiding this button altogether for non-master docs sounds reasonable to me, but using other target branches does not. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Replaces the hardcoded source_branch = "master" in conf.py with dynamic branch detection.
Rationale The "Edit on GitHub" button currently links to master regardless of the active branch. This causes broken links (404s) or hides the button entirely when viewing documentation for stable release branches (e.g., release-1.13) where file paths or content may differ.
Implementation Details
The source_branch is now resolved in the following order:
Read the Docs: Checks os.environ["READTHEDOCS_GIT_IDENTIFIER"].
Local Dev: Falls back to git rev-parse --abbrev-ref HEAD.
Fallback: Defaults to "master" on error.
Fixes #17947