Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit fe4ce1e

Browse files
committed
Remove one TOC level from the release guide
It had one level "All Releases" which has no siblings.
1 parent 7a0d656 commit fe4ce1e

File tree

1 file changed

+16
-18
lines changed

1 file changed

+16
-18
lines changed

doc/devel/release_guide.rst

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
.. _release-guide:
44

5-
===============
6-
Release Guide
7-
===============
5+
=============
6+
Release Guide
7+
=============
88

99

1010
.. admonition:: This document is only relevant for Matplotlib release managers.
@@ -17,13 +17,11 @@
1717
This assumes that a read-only remote for the canonical repository is
1818
``remote`` and a read/write remote is ``DANGER``
1919

20-
All Releases
21-
============
2220

2321
.. _release-testing:
2422

2523
Testing
26-
-------
24+
=======
2725

2826
We use `Travis CI <https://travis-ci.org/matplotlib/matplotlib>`__ for
2927
continuous integration. When preparing for a release, the final
@@ -48,7 +46,7 @@ is currently broken::
4846
.. _release_ghstats:
4947

5048
GitHub Stats
51-
------------
49+
============
5250

5351

5452
We automatically extract GitHub issue, PRs, and authors from GitHub via the
@@ -88,23 +86,23 @@ most common issue is ``*`` which is interpreted as unclosed markup).
8886
.. _release_chkdocs:
8987

9088
Update and Validate the Docs
91-
----------------------------
89+
============================
9290

9391
Merge ``*-doc`` branch
94-
^^^^^^^^^^^^^^^^^^^^^^
92+
----------------------
9593

9694
Merge the most recent 'doc' branch (e.g., ``v3.2.0-doc``) into the branch you
9795
are going to tag on and delete the doc branch on GitHub.
9896

9997
Update supported versions in Security Policy
100-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
98+
--------------------------------------------
10199

102100
When making major or minor releases, update the supported versions in the
103101
Security Policy in :file:`SECURITY.md`. Commonly, this may be one or two
104102
previous minor releases, but is dependent on release managers.
105103

106104
Update "What's New" and "API changes"
107-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
105+
-------------------------------------
108106

109107
Before tagging major and minor releases, the "what's new" and "API changes"
110108
listings should be updated. This is not needed for micro releases.
@@ -126,7 +124,7 @@ Similarly for the "API changes",
126124
In both cases step 3 will have to be un-done right after the release.
127125

128126
Verify that docs build
129-
^^^^^^^^^^^^^^^^^^^^^^
127+
----------------------
130128

131129
Finally, make sure that the docs build cleanly ::
132130

@@ -150,7 +148,7 @@ CI, this should only flag failed external links.
150148
.. _release_tag:
151149

152150
Create release commit and tag
153-
-----------------------------
151+
=============================
154152

155153
To create the tag, first create an empty commit with a very terse set of the release notes
156154
in the commit message ::
@@ -219,7 +217,7 @@ On this branch un-comment the globs from :ref:`release_chkdocs`. And then ::
219217
.. _release_DOI:
220218

221219
Release Management / DOI
222-
------------------------
220+
========================
223221

224222
Via the `GitHub UI
225223
<https://github.com/matplotlib/matplotlib/releases>`__, turn the newly
@@ -247,7 +245,7 @@ to :file:`tools/cache_zenodo_svg.py`, and the changes to
247245
.. _release_bld_bin:
248246

249247
Building binaries
250-
-----------------
248+
=================
251249

252250
We distribute macOS, Windows, and many Linux wheels as well as a source tarball
253251
via PyPI. Most builders should trigger automatically once the tag is pushed to
@@ -286,7 +284,7 @@ This can be done ahead of collecting all of the binaries and uploading to pypi.
286284
.. _release_upload_bin:
287285

288286
Make distribution and upload to PyPI
289-
------------------------------------
287+
====================================
290288

291289
Once you have collected all of the wheels (expect this to take about a
292290
day), generate the tarball ::
@@ -311,7 +309,7 @@ Congratulations, you have now done the second scariest part!
311309
.. _release_docs:
312310

313311
Build and Deploy Documentation
314-
------------------------------
312+
==============================
315313

316314
To build the documentation you must have the tagged version installed, but
317315
build the docs from the ``ver-doc`` branch. An easy way to arrange this is::
@@ -365,7 +363,7 @@ and update the live web page (remember to clear your browser cache).
365363

366364

367365
Announcing
368-
----------
366+
==========
369367

370368
The final step is to announce the release to the world. A short
371369
version of the release notes along with acknowledgments should be sent to

0 commit comments

Comments
 (0)