8000 consolidate version switcher guideance · matplotlib/matplotlib@114b0af · GitHub
[go: up one dir, main page]

Skip to content

Commit 114b0af

Browse files
committed
consolidate version switcher guideance
Merged #30048 then saw that guidance for the version switcher was already in the release guide so consolidating it here.
1 parent 6e4d951 commit 114b0af

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

doc/devel/release_guide.rst

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -233,15 +233,23 @@ Update :file:`doc/users/release_notes.rst`:
233233
../api/prev_api_changes/api_changes_X.Y.Z.rst
234234
prev_whats_new/github_stats_X.Y.Z.rst
235235
236+
.. _update-version-switcher:
237+
236238
Update version switcher
237-
^^^^^^^^^^^^^^^^^^^^^^^
239+
-----------------------
240+
241+
The version switcher is populated from https://matplotlib.org/devdocs/_static/switcher.json.
242+
243+
Since it's always taken from devdocs, update the file :file:`doc/_static/switcher.json`
244+
on the main branch through a regular PR:
238245

239-
Update ``doc/_static/switcher.json``:
246+
- If a micro release, update the version from :samp:`{X}.{Y}.{Z-1}` to :samp:`{X}.{Y}.{Z}`
247+
- If a meso release :samp:`{X}.{Y}.0`:
248+
+ update the dev entry to :samp:`name: {X}.{Y+1} (dev)`
249+
+ update the stable entry to :samp:`name: {X}.{Y} (stable)`
250+
+ add a new entry for the previous stable (:samp:`name: {X}.{Y-1}`).
240251

241-
- If a micro release, :samp:`{X}.{Y}.{Z}`, no changes are needed.
242-
- If a meso release, :samp:`{X}.{Y}.0`, change the name of :samp:`name: {X}.{Y+1} (dev)`
243-
and :samp:`name: {X}.{Y} (stable)` as well as adding a new version for the previous
244-
stable (:samp:`name: {X}.{Y-1}`).
252+
Once that PR is merged, the devdocs site will be updated automatically.
245253

246254
Verify that docs build
247255
----------------------
@@ -465,13 +473,7 @@ If you have access, clear the CloudFlare caches.
465473
It typically takes about 5-10 minutes for the website to process the push and update the
466474
live web page (remember to clear your browser cache).
467475

468-
Update the version switcher
469-
---------------------------
470-
The version switcher is populated from https://matplotlib.org/devdocs/_static/switcher.json.
471-
472-
Since it's always taken from devdocs, update the file :file:`doc/_static/switcher.json`
473-
on the main branch through a regular PR. Once that PR is merged, the devdocs site
474-
will be updated automatically.
476+
Remember to :ref:`update the version switcher <update-version-switcher>`!
475477

476478
.. _release_merge_up:
477479

0 commit comments

Comments
 (0)
0