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 to 3-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 v in 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).
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).