Standardize changelog headers and make sure headers have stable IDs in Sphinx #1859
+248
−222
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
…n Sphinx Signed-off-by: Jean-Christophe Morin <[email protected]>
JeanChristopheMorinPerso
force-pushed
the
docs_changelog_stable_header_ids
branch
from
8debc1c
to
ea8a748
Compare
JeanChristopheMorinPerso
merged commit b46d435
into
AcademySoftwareFoundation:main
5 checks passed
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.
I noticed that the changelog at https://rez.readthedocs.io/en/stable/changelog.html doesn't have real and stable IDs for each version. For example, https://rez.readthedocs.io/en/stable/changelog.html#id1 leads to 3.1.1... That's not great.
It turns out that sphinx doesn't like headers that contain only numbers. After debugging sphinx a little, I saw that
3.1.1 (2024-04-14)was being converted to3-1-1-2024-04-14. When sphinx sees that, it strips all non-valid leading characters (so numbers and-) which results in an empty string. It then assigns a generic ID.So this PR adds a
vin front of each entry in the changelog.While being there, I also took the time to standardize on the format a little bit so that each entry use the same format (except for older versions where I didn't bother to get the release date).