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

Skip to content

Commit 53b29f4

Browse files
authored
consolidate version switcher guideance
Merged matplotlib#30048 then saw that guidance for the version switcher was already in the release guide so consolidating it here.
1 parent dd3e322 commit 53b29f4

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

doc/devel/release_guide.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -233,16 +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.
238241

239-
Update ``doc/_static/switcher.json``:
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:
240244

241245
- If a micro release, :samp:`{X}.{Y}.{Z}`, no changes are needed.
242246
- If a meso release, :samp:`{X}.{Y}.0`, change the name of :samp:`name: {X}.{Y+1} (dev)`
243247
and :samp:`name: {X}.{Y} (stable)` as well as adding a new version for the previous
244248
stable (:samp:`name: {X}.{Y-1}`).
245249

250+
Once that PR is merged, the devdocs site will be updated automatically.
251+
246252
Verify that docs build
247253
----------------------
248254

@@ -463,15 +469,9 @@ Congratulations you have now done the third scariest part!
463469
If you have access, clear the CloudFlare caches.
464470

465471
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).
472+
live web page (remember to clear your browser cache).
467473

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

476476
.. _release_merge_up:
477477

0 commit comments

Comments
 (0)
0