From c967bbccb52da5ddc94b35c1ce35b32090bbbe0b Mon Sep 17 00:00:00 2001 From: Tiago Nobrega Date: Thu, 26 Sep 2024 18:58:54 -0300 Subject: [PATCH] docs: add a table of contents for the versions These two facts: - Changelog entries for a given version can be rather long - We order the versions "chronologically" instead of "numerically" ... mean that the entries for a given major version can get "hidden" further down the page if multiple hotfixes have been released in the meantime. This can cause confusion and make it seem like the version has not been released, or at least doesn't have changelog entries. To alleviate this, add a table of contents that links to the subsection for each release. --- docs/reference/changelog.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/reference/changelog.rst b/docs/reference/changelog.rst index fbc344f8ac..603e575f44 100644 --- a/docs/reference/changelog.rst +++ b/docs/reference/changelog.rst @@ -68,6 +68,10 @@ Changelog For a complete list of commits, check out the `X.Y.Z`_ release on GitHub. +.. contents:: + :class: this-will-duplicate-information-and-it-is-still-useful-here + :local: + 8.4.1 (2024-Sep-20) -------------------