@@ -233,15 +233,22 @@ Update :file:`doc/users/release_notes.rst`:
233
233
../api/prev_api_changes/api_changes_X.Y.Z.rst
234
234
prev_whats_new/github_stats_X.Y.Z.rst
235
235
236
+ .. _update-version-switcher :
237
+
236
238
Update version switcher
237
239
^^^^^^^^^^^^^^^^^^^^^^^
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:
238
244
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 } `).
240
250
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.
245
252
246
253
Verify that docs build
247
254
----------------------
@@ -465,13 +472,7 @@ If you have access, clear the CloudFlare caches.
465
472
It typically takes about 5-10 minutes for the website to process the push and update the
466
473
live web page (remember to clear your browser cache).
467
474
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 `!
475
476
476
477
.. _release_merge_up :
477
478
0 commit comments