Skip to content

Clean up table of contents in release notes #27898

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.

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

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 0 additions & 4 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -550,10 +550,6 @@ def js_tag_with_cache_busting(js):
"cheatsheet_sidebar.html",
"donate_sidebar.html",
],
# no sidebar for release notes, because that page is only a collection of links
# to sub-pages. The sidebar would repeat all the titles of the sub-pages and
# thus basically repeat all the content of the page.
"users/release_notes": ["empty_sidebar.html"],
# '**': ['localtoc.html', 'pagesource.html']
}

Expand Down
30 changes: 8 additions & 22 deletions doc/devel/release_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,26 +123,12 @@ GitHub statistics
We automatically extract GitHub issue, PRs, and authors from GitHub via the API. To
prepare this list:

1. Archive the existing GitHub statistics page.

a. Copy the current :file:`doc/users/github_stats.rst` to
:file:`doc/users/prev_whats_new/github_stats_{X}.{Y}.{Z}.rst`.
b. Change the link target at the top of the file.
c. Remove the "Previous GitHub Stats" section at the end.

For example, when updating from v3.7.0 to v3.7.1::

cp doc/users/github_stats.rst doc/users/prev_whats_new/github_stats_3.7.0.rst
$EDITOR doc/users/prev_whats_new/github_stats_3.7.0.rst
# Change contents as noted above.
git add doc/users/prev_whats_new/github_stats_3.7.0.rst

2. Re-generate the updated stats::
1. Re-generate the stats, e.g., for version 3.7.1::

python tools/github_stats.py --since-tag v3.7.0 --milestone=v3.7.1 \
--project 'matplotlib/matplotlib' --links > doc/users/github_stats.rst
--project 'matplotlib/matplotlib' --links > doc/users/prev_whats_new/github_stats_3.7.1.rst

3. Review and commit changes. Some issue/PR titles may not be valid reST (the most
2. Review and commit changes. Some issue/PR titles may not be valid reST (the most
common issue is ``*`` which is interpreted as unclosed markup).

.. note::
Expand Down Expand Up @@ -210,22 +196,22 @@ individual files.
Release notes TOC
^^^^^^^^^^^^^^^^^

Update :file:`doc/users/release_notes.rst`:

- For macro and meso releases add a new section
- For macro and meso releases create a new :file:`doc/users/{X}.{Y}.rst` file, and
add it to the table of contents on :file:`doc/users/release_notes.rst`.

.. code:: rst

X.Y
===
^^^
.. toctree::
:maxdepth: 1

prev_whats_new/whats_new_X.Y.0.rst
../api/prev_api_changes/api_changes_X.Y.0.rst
prev_whats_new/github_stats_X.Y.0.rst

- For micro releases add the GitHub stats and (if present) the API changes to
the existing X.Y section
:file:`doc/users/{X}.{Y}.rst`

.. code:: rst

Expand Down
43 changes: 43 additions & 0 deletions doc/users/0.x.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
Pre version 1.0
^^^^^^^^^^^^^^^
.. toctree::
:maxdepth: 1

prev_whats_new/changelog.rst
prev_whats_new/whats_new_0.99.rst
../api/prev_api_changes/api_changes_0.99.x.rst
../api/prev_api_changes/api_changes_0.99.rst
prev_whats_new/whats_new_0.98.4.rst
../api/prev_api_changes/api_changes_0.98.x.rst
../api/prev_api_changes/api_changes_0.98.1.rst
../api/prev_api_changes/api_changes_0.98.0.rst
../api/prev_api_changes/api_changes_0.91.2.rst
../api/prev_api_changes/api_changes_0.91.0.rst
../api/prev_api_changes/api_changes_0.90.1.rst
../api/prev_api_changes/api_changes_0.90.0.rst

../api/prev_api_changes/api_changes_0.87.7.rst
../api/prev_api_changes/api_changes_0.86.rst
../api/prev_api_changes/api_changes_0.85.rst
../api/prev_api_changes/api_changes_0.84.rst
../api/prev_api_changes/api_changes_0.83.rst
../api/prev_api_changes/api_changes_0.82.rst
../api/prev_api_changes/api_changes_0.81.rst
../api/prev_api_changes/api_changes_0.80.rst

../api/prev_api_changes/api_changes_0.73.rst
../api/prev_api_changes/api_changes_0.72.rst
../api/prev_api_changes/api_changes_0.71.rst
../api/prev_api_changes/api_changes_0.70.rst

../api/prev_api_changes/api_changes_0.65.1.rst
../api/prev_api_changes/api_changes_0.65.rst
../api/prev_api_changes/api_changes_0.63.rst
../api/prev_api_changes/api_changes_0.61.rst
../api/prev_api_changes/api_changes_0.60.rst

../api/prev_api_changes/api_changes_0.54.3.rst
../api/prev_api_changes/api_changes_0.54.rst
../api/prev_api_changes/api_changes_0.50.rst
../api/prev_api_changes/api_changes_0.42.rst
../api/prev_api_changes/api_changes_0.40.rst
6 changes: 6 additions & 0 deletions doc/users/1.0.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Version 1.0
^^^^^^^^^^^
.. toctree::
:maxdepth: 1

prev_whats_new/whats_new_1.0.rst
7 changes: 7 additions & 0 deletions doc/users/1.1.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Version 1.1
^^^^^^^^^^^
.. toctree::
:maxdepth: 1

prev_whats_new/whats_new_1.1.rst
../api/prev_api_changes/api_changes_1.1.x.rst
8 changes: 8 additions & 0 deletions doc/users/1.2.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Version 1.2
^^^^^^^^^^^
.. toctree::
:maxdepth: 1

prev_whats_new/whats_new_1.2.2.rst
prev_whats_new/whats_new_1.2.rst
../api/prev_api_changes/api_changes_1.2.x.rst
7 changes: 7 additions & 0 deletions doc/users/1.3.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Version 1.3
^^^^^^^^^^^
.. toctree::
:maxdepth: 1

prev_whats_new/whats_new_1.3.rst
../api/prev_api_changes/api_changes_1.3.x.rst
7 changes: 7 additions & 0 deletions doc/users/1.4.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Version 1.4
^^^^^^^^^^^
.. toctree::
:maxdepth: 1

prev_whats_new/whats_new_1.4.rst
../api/prev_api_changes/api_changes_1.4.x.rst
9 changes: 9 additions & 0 deletions doc/users/1.5.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Version 1.5
^^^^^^^^^^^
.. toctree::
:maxdepth: 1

prev_whats_new/whats_new_1.5.rst
../api/prev_api_changes/api_changes_1.5.3.rst
../api/prev_api_changes/api_changes_1.5.2.rst
../api/prev_api_changes/api_changes_1.5.0.rst
8 changes: 8 additions & 0 deletions doc/users/2.0.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Version 2.0
^^^^^^^^^^^
.. toctree::
:maxdepth: 1

prev_whats_new/whats_new_2.0.0.rst
../api/prev_api_changes/api_changes_2.0.1.rst
../api/prev_api_changes/api_changes_2.0.0.rst
9 changes: 9 additions & 0 deletions doc/users/2.1.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Version 2.1
^^^^^^^^^^^
.. toctree::
:maxdepth: 1

prev_whats_new/whats_new_2.1.0.rst
../api/prev_api_changes/api_changes_2.1.2.rst
../api/prev_api_changes/api_changes_2.1.1.rst
../api/prev_api_changes/api_changes_2.1.0.rst
7 changes: 7 additions & 0 deletions doc/users/2.2.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Version 2.2
^^^^^^^^^^^
.. toctree::
:maxdepth: 1

prev_whats_new/whats_new_2.2.rst
../api/prev_api_changes/api_changes_2.2.0.rst
12 changes: 12 additions & 0 deletions doc/users/3.0.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Version 3.0
^^^^^^^^^^^
.. toctree::
:maxdepth: 1

prev_whats_new/whats_new_3.0.rst
../api/prev_api_changes/api_changes_3.0.1.rst
../api/prev_api_changes/api_changes_3.0.0.rst
prev_whats_new/github_stats_3.0.3.rst
prev_whats_new/github_stats_3.0.2.rst
prev_whats_new/github_stats_3.0.1.rst
prev_whats_new/github_stats_3.0.0.rst
12 changes: 12 additions & 0 deletions doc/users/3.1.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Version 3.1
^^^^^^^^^^^
.. toctree::
:maxdepth: 1

prev_whats_new/whats_new_3.1.0.rst
../api/prev_api_changes/api_changes_3.1.1.rst
../api/prev_api_changes/api_changes_3.1.0.rst
prev_whats_new/github_stats_3.1.3.rst
prev_whats_new/github_stats_3.1.2.rst
prev_whats_new/github_stats_3.1.1.rst
prev_whats_new/github_stats_3.1.0.rst
10 changes: 10 additions & 0 deletions doc/users/3.2.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Version 3.2
^^^^^^^^^^^
.. toctree::
:maxdepth: 1

prev_whats_new/whats_new_3.2.0.rst
../api/prev_api_changes/api_changes_3.2.0.rst
prev_whats_new/github_stats_3.2.2.rst
prev_whats_new/github_stats_3.2.1.rst
prev_whats_new/github_stats_3.2.0.rst
13 changes: 13 additions & 0 deletions doc/users/3.3.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Version 3.3
^^^^^^^^^^^
.. toctree::
:maxdepth: 1

prev_whats_new/whats_new_3.3.0.rst
../api/prev_api_changes/api_changes_3.3.1.rst
../api/prev_api_changes/api_changes_3.3.0.rst
prev_whats_new/github_stats_3.3.4.rst
prev_whats_new/github_stats_3.3.3.rst
prev_whats_new/github_stats_3.3.2.rst
prev_whats_new/github_stats_3.3.1.rst
prev_whats_new/github_stats_3.3.0.rst
12 changes: 12 additions & 0 deletions doc/users/3.4.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Version 3.4
^^^^^^^^^^^
.. toctree::
:maxdepth: 1

prev_whats_new/whats_new_3.4.0.rst
../api/prev_api_changes/api_changes_3.4.2.rst
../api/prev_api_changes/api_changes_3.4.0.rst
prev_whats_new/github_stats_3.4.3.rst
prev_whats_new/github_stats_3.4.2.rst
prev_whats_new/github_stats_3.4.1.rst
prev_whats_new/github_stats_3.4.0.rst
14 changes: 14 additions & 0 deletions doc/users/3.5.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Version 3.5
^^^^^^^^^^^
.. toctree::
:maxdepth: 1

prev_whats_new/whats_new_3.5.2.rst
prev_whats_new/whats_new_3.5.0.rst
../api/prev_api_changes/api_changes_3.5.3.rst
../api/prev_api_changes/api_changes_3.5.2.rst
../api/prev_api_changes/api_changes_3.5.0.rst
prev_whats_new/github_stats_3.5.3.rst
prev_whats_new/github_stats_3.5.2.rst
prev_whats_new/github_stats_3.5.1.rst
prev_whats_new/github_stats_3.5.0.rst
12 changes: 12 additions & 0 deletions doc/users/3.6.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Version 3.6
^^^^^^^^^^^
.. toctree::
:maxdepth: 1

prev_whats_new/whats_new_3.6.0.rst
../api/prev_api_changes/api_changes_3.6.1.rst
../api/prev_api_changes/api_changes_3.6.0.rst
prev_whats_new/github_stats_3.6.3.rst
prev_whats_new/github_stats_3.6.2.rst
prev_whats_new/github_stats_3.6.1.rst
prev_whats_new/github_stats_3.6.0.rst
11 changes: 11 additions & 0 deletions doc/users/3.7.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Version 3.7
^^^^^^^^^^^
.. toctree::
:maxdepth: 1

prev_whats_new/whats_new_3.7.0.rst
../api/prev_api_changes/api_changes_3.7.0.rst
prev_whats_new/github_stats_3.7.3.rst
prev_whats_new/github_stats_3.7.2.rst
prev_whats_new/github_stats_3.7.1.rst
prev_whats_new/github_stats_3.7.0.rst
13 changes: 13 additions & 0 deletions doc/users/3.8.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Version 3.8
^^^^^^^^^^^

.. toctree::
:maxdepth: 1

prev_whats_new/whats_new_3.8.0.rst
../api/prev_api_changes/api_changes_3.8.1.rst
../api/prev_api_changes/api_changes_3.8.0.rst
prev_whats_new/github_stats_3.8.3.rst
prev_whats_new/github_stats_3.8.2.rst
prev_whats_new/github_stats_3.8.1.rst
prev_whats_new/github_stats_3.8.0.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _github-stats:
.. _github-stats-3-8-3:

GitHub statistics for 3.8.3 (Feb 14, 2024)
==========================================
Expand Down Expand Up @@ -137,14 +137,3 @@ Issues (18):
* :ghissue:`27461`: [Doc]: API interface overview pylab incorrect import statement: from matplotlib.pyplot import *
* :ghissue:`27383`: [Bug]: Error in Hexbin plot in Matplotlib 3.0 onward
* :ghissue:`27358`: [Doc]: Garbled menu widget example output


Previous GitHub statistics
--------------------------

.. toctree::
:maxdepth: 1
:glob:
:reversed:

prev_whats_new/github_stats_*
4 changes: 2 additions & 2 deletions doc/users/prev_whats_new/whats_new_3.1.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ What's new in Matplotlib 3.1 (May 18, 2019)
===========================================

For a list of all of the issues and pull requests since the last
revision, see the :ref:`github-stats`.
revision, see the :ref:`github-stats-3-1-0`.

.. contents:: Table of Contents
:depth: 4
Expand Down Expand Up @@ -179,7 +179,7 @@ changed.
Alternatively to strings like ``"data"`` or ``"axes fraction"``,
`.ConnectionPatch` now accepts any `~matplotlib.transforms.Transform` as input
for the *coordsA* and *coordsB* arguments. This allows to draw lines between
points defined in different user defined coordinate systems. Also see
points defined in different user defined coordinate systems. Also see
:ref:`using_connectionpatch`.

mplot3d Line3D now allows {set,get}_data_3d
Expand Down
2 changes: 1 addition & 1 deletion doc/users/prev_whats_new/whats_new_3.2.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ What's new in Matplotlib 3.2 (Mar 04, 2020)
===========================================

For a list of all of the issues and pull requests since the last
revision, see the :ref:`github-stats`.
revision, see the :ref:`github-stats-3-2-0`.

.. contents:: Table of Contents
:depth: 4
Expand Down
2 changes: 1 addition & 1 deletion doc/users/prev_whats_new/whats_new_3.3.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ What's new in Matplotlib 3.3.0 (Jul 16, 2020)
=============================================

For a list of all of the issues and pull requests since the last
revision, see the :ref:`github-stats`.
revision, see the :ref:`github-stats-3-3-0`.

.. contents:: Table of Contents
:depth: 4
Expand Down
2 changes: 1 addition & 1 deletion doc/users/prev_whats_new/whats_new_3.4.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ What's new in Matplotlib 3.4.0 (Mar 26, 2021)
=============================================

For a list of all of the issues and pull requests since the last revision, see
the :ref:`github-stats`.
the :ref:`github-stats-3-4-0`.

.. contents:: Table of Contents
:depth: 4
Expand Down
2 changes: 1 addition & 1 deletion doc/users/prev_whats_new/whats_new_3.5.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ What's new in Matplotlib 3.5.0 (Nov 15, 2021)
=============================================

For a list of all of the issues and pull requests since the last revision, see
the :ref:`github-stats`.
the :ref:`github-stats-3-5-0`.

.. contents:: Table of Contents
:depth: 4
Expand Down
2 changes: 1 addition & 1 deletion doc/users/prev_whats_new/whats_new_3.5.2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ What's new in Matplotlib 3.5.2 (May 02, 2022)
=============================================

For a list of all of the issues and pull requests since the last revision, see
the :ref:`github-stats`.
the :ref:`github-stats-3-5-0`.

.. contents:: Table of Contents
:depth: 4
Expand Down
Loading