Set edit links dynamically for RtD preview and PR builds#3280
Open
mnocon wants to merge 1 commit into
Open
Conversation
|
Preview of modified files: no change to preview. |
bfccad4 to
0496399
Compare
Summary
|
0496399 to
b14948b
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Target: 5.0, 6.0
The current link checker has a bug: for new Markdown files, it reports 404 for "View on GitHub" button:
#3279 (comment)
This is because the 5.0 branch is hardcoded as "edit_uri", and it looks into the 5.0 branch for changes that were not merged yet.
This PR sets the value dynamically, so for it will work correctly for PRs and for ReadTheDocs preview builds.
Doc:
(from https://docs.readthedocs.com/platform/stable/reference/environment-variables.html )
So for RTD previews, commit hash is used.
Tested locally by setting the variable before building and checking the output in the
sitedir: