[BUG] Fix redirect-from Sphinx extension #27915
Merged
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
Update merge_domaindata to match Sphinx example implementation https://github.com/sphinx-doc/sphinx/blob/5523c9bbe4d1415777669330411d4f00ad802f18/sphinx/ext/todo.py#L90-L92
Check causes build to fail when Sphinx uses a cached build environment. We can just rewrite the cached redirect.
timhoffm
reviewed
Mar 14, 2024
|
If the docs build successfully the first time with no changes, Sphinx will load in a cached build environment with |
But that suggests the checks are doing their job and we still have a bug? |
* Added domain.redirects sanity check back in * Clear cached redirects from the domain
…com/AnsonTran/matplotlib into fix-sphinx-redirect-from-directives
|
Added the sanity checks back in. Also added a function to clear the domain redirects, so build doesnt fail when rebuilding without doing a |
timhoffm
reviewed
Mar 15, 2024
timhoffm
approved these changes
Mar 18, 2024
QuLogic
reviewed
Mar 19, 2024
Implement suggested changes Co-authored-by: Elliott Sales de Andrade <[email protected]>
QuLogic
approved these changes
Mar 20, 2024
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.
PR summary
Closes #27911, closes #21876. This PR fixes the issue of redirect-from directives not
creating the relative refresh pages in the build.
PR checklist