sitemap.py: sort work list for a stable sitemap.xml #4615
Merged
Conversation
This file contains 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
The default ordering of env.found_docs seems to be unstable in newer Sphinx versions, resulting in sitemap.xml changes every single time the website builder runs, even if nothing actually changed. With this list now processed in sorted order, sitemap.xml shouldn't change unless we've actually added, removed, or renamed documents.
elliefm
added
backport-to-3.6
|
@elliefm: this needs to be backported all the way to 2.5 |
rsto
approved these changes
Aug 23, 2023
elliefm
removed
backport-to-3.6
|
This is now backported as far as 3.0. Turns out 2.5 doesn't have the sitemap builder, so doesn't need the fix. |
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.
The default ordering of
env.found_docsseems to be unstable in newer Sphinx versions, resulting in sitemap.xml changes every single time the website builder runs, even if nothing actually changed.With this list now processed in sorted order, sitemap.xml shouldn't change unless we've actually added, removed, or renamed documents.