Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit 86bf72d

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 86bf72d

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

‎doc/devel/release_guide.rst

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -233,15 +233,22 @@ 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
237239
^^^^^^^^^^^^^^^^^^^^^^^
240+
The version switcher is populated from https://matplotlib.org/devdocs/_static/switcher.json.
241+
242+
Since it's always taken from devdocs, update the file :file:`doc/_static/switcher.json`
243+
on the main branch through a regular PR:
238244

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

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}`).
251+
Once that PR is merged, the devdocs site will be updated automatically.
245252

246253
Verify that docs build
247254
----------------------
@@ -463,15 +470,9 @@ Congratulations you have now done the third scariest part!
463470
If you have access, clear the CloudFlare caches.
464471

465472
It typically takes about 5-10 minutes for the website to process the push and update the
466-
live web page (remember to clear your browser cache).
473+
live web page (remember to clear your browser cache).
467474

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.
475+
Remember to :ref:`update the version switcher <update-version-switcher`!
475476

476477
.. _release_merge_up:
477478

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /