From 114b0aff1ae2018131be866bb638072e8e21d6f9 Mon Sep 17 00:00:00 2001 From: hannah Date: Tue, 13 May 2025 17:15:31 -0400 Subject: [PATCH 1/2] consolidate version switcher guideance Merged #30048 then saw that guidance for the version switcher was already in the release guide so consolidating it here. --- doc/devel/release_guide.rst | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/doc/devel/release_guide.rst b/doc/devel/release_guide.rst index 0ca3c06084d9..51505539cf34 100644 --- a/doc/devel/release_guide.rst +++ b/doc/devel/release_guide.rst @@ -233,15 +233,23 @@ Update :file:`doc/users/release_notes.rst`: ../api/prev_api_changes/api_changes_X.Y.Z.rst prev_whats_new/github_stats_X.Y.Z.rst +.. _update-version-switcher: + Update version switcher -^^^^^^^^^^^^^^^^^^^^^^^ +----------------------- + +The version switcher is populated from https://matplotlib.org/devdocs/_static/switcher.json. + +Since it's always taken from devdocs, update the file :file:`doc/_static/switcher.json` +on the main branch through a regular PR: -Update ``doc/_static/switcher.json``: +- If a micro release, update the version from :samp:`{X}.{Y}.{Z-1}` to :samp:`{X}.{Y}.{Z}` +- If a meso release :samp:`{X}.{Y}.0`: + + update the dev entry to :samp:`name: {X}.{Y+1} (dev)` + + update the stable entry to :samp:`name: {X}.{Y} (stable)` + + add a new entry for the previous stable (:samp:`name: {X}.{Y-1}`). -- If a micro release, :samp:`{X}.{Y}.{Z}`, no changes are needed. -- If a meso release, :samp:`{X}.{Y}.0`, change the name of :samp:`name: {X}.{Y+1} (dev)` - and :samp:`name: {X}.{Y} (stable)` as well as adding a new version for the previous - stable (:samp:`name: {X}.{Y-1}`). +Once that PR is merged, the devdocs site will be updated automatically. Verify that docs build ---------------------- @@ -465,13 +473,7 @@ If you have access, clear the CloudFlare caches. It typically takes about 5-10 minutes for the website to process the push and update the live web page (remember to clear your browser cache). -Update the version switcher ---------------------------- -The version switcher is populated from https://matplotlib.org/devdocs/_static/switcher.json. - -Since it's always taken from devdocs, update the file :file:`doc/_static/switcher.json` -on the main branch through a regular PR. Once that PR is merged, the devdocs site -will be updated automatically. +Remember to :ref:`update the version switcher `! .. _release_merge_up: From 85f1ee16249eb9888b77f30fc9ea8f1a96d963a5 Mon Sep 17 00:00:00 2001 From: hannah Date: Tue, 13 May 2025 21:48:14 -0400 Subject: [PATCH 2/2] Update doc/devel/release_guide.rst Co-authored-by: Elliott Sales de Andrade --- doc/devel/release_guide.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/devel/release_guide.rst b/doc/devel/release_guide.rst index 51505539cf34..6c45bfa56c64 100644 --- a/doc/devel/release_guide.rst +++ b/doc/devel/release_guide.rst @@ -245,6 +245,7 @@ on the main branch through a regular PR: - If a micro release, update the version from :samp:`{X}.{Y}.{Z-1}` to :samp:`{X}.{Y}.{Z}` - If a meso release :samp:`{X}.{Y}.0`: + + update the dev entry to :samp:`name: {X}.{Y+1} (dev)` + update the stable entry to :samp:`name: {X}.{Y} (stable)` + add a new entry for the previous stable (:samp:`name: {X}.{Y-1}`).