8000 DOC: consolidate version switcher guidance by story645 · Pull Request #30049 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

DOC: consolidate version switcher guidance #30049

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 14, 2025
+16 −13
Merged

DOC: consolidate version switcher guidance #30049

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
114b0af
consolidate version switcher guideance
story645 May 13, 2025
85f1ee1
Update doc/devel/release_guide.rst
story645 May 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 16 additions & 13 deletions doc/devel/release_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,15 +233,24 @@ Update :file:`doc/users/release_notes.rst`:
../api/prev_api_changes/api_changes_X.Y.Z.rst
prev_whats_new/github_stats_X.Y.Z.rst

.. _update-version-switcher:

Update version switcher
^^^^^^^^^^^^^^^^^^^^^^^
-----------------------

The version switcher is populated from https://matplotlib.org/devdocs/_static/switcher.json.

Since it's always taken from devdocs, update the file :file:`doc/_static/switcher.json`
on the main branch through a regular PR:

Update ``doc/_static/switcher.json``:
- If a micro release, update the version from :samp:`{X}.{Y}.{Z-1}` to :samp:`{X}.{Y}.{Z}`
- If a meso release :samp:`{X}.{Y}.0`:

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

Once that PR is merged, the devdocs site will be updated automatically.

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

Update the version switcher
---------------------------
The version switcher is populated from https://matplotlib.org/devdocs/_static/switcher.json.

Since it's always taken from devdocs, update the file :file:`doc/_static/switcher.json`
on the main branch through a regular PR. Once that PR is merged, the devdocs site
will be updated automatically.
Remember to :ref:`update the version switcher <update-version-switcher>`!

.. _release_merge_up:

Expand Down
0