Skip to content

Commit 639b341

Browse files
dstansbydstansby
committed
Clean up table of contents in release notes
1 parent ab200b6 commit 639b341

34 files changed

+286
-266
lines changed

‎doc/conf.py

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -551,10 +551,6 @@ def js_tag_with_cache_busting(js):
551551
"cheatsheet_sidebar.html",
552552
"donate_sidebar.html",
553553
],
554-
# no sidebar for release notes, because that page is only a collection of links
555-
# to sub-pages. The sidebar would repeat all the titles of the sub-pages and
556-
# thus basically repeat all the content of the page.
557-
"users/release_notes": ["empty_sidebar.html"],
558554
# '**': ['localtoc.html', 'pagesource.html']
559555
}
560556

‎doc/devel/release_guide.rst

Lines changed: 8 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -123,26 +123,12 @@ GitHub statistics
123123
We automatically extract GitHub issue, PRs, and authors from GitHub via the API. To
124124
prepare this list:
125125

126-
1. Archive the existing GitHub statistics page.
127-
128-
a. Copy the current :file:`doc/users/github_stats.rst` to
129-
:file:`doc/users/prev_whats_new/github_stats_{X}.{Y}.{Z}.rst`.
130-
b. Change the link target at the top of the file.
131-
c. Remove the "Previous GitHub Stats" section at the end.
132-
133-
For example, when updating from v3.7.0 to v3.7.1::
134-
135-
cp doc/users/github_stats.rst doc/users/prev_whats_new/github_stats_3.7.0.rst
136-
$EDITOR doc/users/prev_whats_new/github_stats_3.7.0.rst
137-
# Change contents as noted above.
138-
git add doc/users/prev_whats_new/github_stats_3.7.0.rst
139-
140-
2. Re-generate the updated stats::
126+
1. Re-generate the stats, e.g., for version 3.7.1::
141127

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

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

148134
.. note::
@@ -210,22 +196,22 @@ individual files.
210196
Release notes TOC
211197
^^^^^^^^^^^^^^^^^
212198

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

217202
.. code:: rst
218203
219204
X.Y
220-
===
205+
^^^
221206
.. toctree::
222207
:maxdepth: 1
223208
224209
prev_whats_new/whats_new_X.Y.0.rst
225210
../api/prev_api_changes/api_changes_X.Y.0.rst
226211
prev_whats_new/github_stats_X.Y.0.rst
212+
227213
- For micro releases add the GitHub stats and (if present) the API changes to
228-
the existing X.Y section
214+
:file:`doc/users/{X}.{Y}.rst`
229215

230216
.. code:: rst
231217

‎doc/users/0.x.rst

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
Pre version 1.0
2+
^^^^^^^^^^^^^^^
3+
.. toctree::
4+
:maxdepth: 1
5+
6+
prev_whats_new/changelog.rst
7+
prev_whats_new/whats_new_0.99.rst
8+
../api/prev_api_changes/api_changes_0.99.x.rst
9+
../api/prev_api_changes/api_changes_0.99.rst
10+
prev_whats_new/whats_new_0.98.4.rst
11+
../api/prev_api_changes/api_changes_0.98.x.rst
12+
../api/prev_api_changes/api_changes_0.98.1.rst
13+
../api/prev_api_changes/api_changes_0.98.0.rst
14+
../api/prev_api_changes/api_changes_0.91.2.rst
15+
../api/prev_api_changes/api_changes_0.91.0.rst
16+
../api/prev_api_changes/api_changes_0.90.1.rst
17+
../api/prev_api_changes/api_changes_0.90.0.rst
18+
19+
../api/prev_api_changes/api_changes_0.87.7.rst
20+
../api/prev_api_changes/api_changes_0.86.rst
21+
../api/prev_api_changes/api_changes_0.85.rst
22+
../api/prev_api_changes/api_changes_0.84.rst
23+
../api/prev_api_changes/api_changes_0.83.rst
24+
../api/prev_api_changes/api_changes_0.82.rst
25+
../api/prev_api_changes/api_changes_0.81.rst
26+
../api/prev_api_changes/api_changes_0.80.rst
27+
28+
../api/prev_api_changes/api_changes_0.73.rst
29+
../api/prev_api_changes/api_changes_0.72.rst
30+
../api/prev_api_changes/api_changes_0.71.rst
31+
../api/prev_api_changes/api_changes_0.70.rst
32+
33+
../api/prev_api_changes/api_changes_0.65.1.rst
34+
../api/prev_api_changes/api_changes_0.65.rst
35+
../api/prev_api_changes/api_changes_0.63.rst
36+
../api/prev_api_changes/api_changes_0.61.rst
37+
../api/prev_api_changes/api_changes_0.60.rst
38+
39+
../api/prev_api_changes/api_changes_0.54.3.rst
40+
../api/prev_api_changes/api_changes_0.54.rst
41+
../api/prev_api_changes/api_changes_0.50.rst
42+
../api/prev_api_changes/api_changes_0.42.rst
43+
../api/prev_api_changes/api_changes_0.40.rst

‎doc/users/1.0.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Version 1.0
2+
^^^^^^^^^^^
3+
.. toctree::
4+
:maxdepth: 1
5+
6+
prev_whats_new/whats_new_1.0.rst

‎doc/users/1.1.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Version 1.1
2+
^^^^^^^^^^^
3+
.. toctree::
4+
:maxdepth: 1
5+
6+
prev_whats_new/whats_new_1.1.rst
7+
../api/prev_api_changes/api_changes_1.1.x.rst

‎doc/users/1.2.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Version 1.2
2+
^^^^^^^^^^^
3+
.. toctree::
4+
:maxdepth: 1
5+
6+
prev_whats_new/whats_new_1.2.2.rst
7+
prev_whats_new/whats_new_1.2.rst
8+
../api/prev_api_changes/api_changes_1.2.x.rst

‎doc/users/1.3.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Version 1.3
2+
^^^^^^^^^^^
3+
.. toctree::
4+
:maxdepth: 1
5+
6+
prev_whats_new/whats_new_1.3.rst
7+
../api/prev_api_changes/api_changes_1.3.x.rst

‎doc/users/1.4.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Version 1.4
2+
^^^^^^^^^^^
3+
.. toctree::
4+
:maxdepth: 1
5+
6+
prev_whats_new/whats_new_1.4.rst
7+
../api/prev_api_changes/api_changes_1.4.x.rst

‎doc/users/1.5.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Version 1.5
2+
^^^^^^^^^^^
3+
.. toctree::
4+
:maxdepth: 1
5+
6+
prev_whats_new/whats_new_1.5.rst
7+
../api/prev_api_changes/api_changes_1.5.3.rst
8+
../api/prev_api_changes/api_changes_1.5.2.rst
9+
../api/prev_api_changes/api_changes_1.5.0.rst

‎doc/users/2.0.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Version 2.0
2+
^^^^^^^^^^^
3+
.. toctree::
4+
:maxdepth: 1
5+
6+
prev_whats_new/whats_new_2.0.0.rst
7+
../api/prev_api_changes/api_changes_2.0.1.rst
8+
../api/prev_api_changes/api_changes_2.0.0.rst

0 commit comments

Comments
 (0)