@@ -233,15 +233,24 @@ 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+
236238Update 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 `:
240248
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 } `).
249+ + update the dev entry to :samp: `name: { X } .{ Y+1 } (dev) `
250+ + update the stable entry to :samp: `name: { X } .{ Y } (stable) `
251+ + add a new entry for the previous stable (:samp: `name: { X } .{ Y-1 } `).
252+
253+ Once that PR is merged, the devdocs site will be updated automatically.
245254
246255Verify that docs build
247256----------------------
@@ -465,13 +474,7 @@ If you have access, clear the CloudFlare caches.
465474It typically takes about 5-10 minutes for the website to process the push and update the
466475live web page (remember to clear your browser cache).
467476
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.
477+ Remember to :ref: `update the version switcher <update-version-switcher >`!
475478
476479.. _release_merge_up :
477480
0 commit comments