diff options
| author | Jarrod Millman <jarrod.millman@gmail.com> | 2017-07-26 16:33:44 -0700 |
|---|---|---|
| committer | Jarrod Millman <jarrod.millman@gmail.com> | 2017-07-26 22:44:00 -0700 |
| commit | 157a28c9a76371d55088de1b3d9c6b1ce734b13d (patch) | |
| tree | c23a37256800ba66fc4c961e13c7eb59f4f94698 /RELEASE.rst | |
| parent | 1515509a6e0cdcc311442cb390b1dcaf9de2572e (diff) | |
| download | networkx-157a28c9a76371d55088de1b3d9c6b1ce734b13d.tar.gz | |
Fix doctests
Ran ``make doctests`` from ``doc`` and then fixed everything
Diffstat (limited to 'RELEASE.rst')
| -rw-r--r-- | RELEASE.rst | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/RELEASE.rst b/RELEASE.rst index 2f7f4920..18057926 100644 --- a/RELEASE.rst +++ b/RELEASE.rst @@ -3,20 +3,25 @@ How to make a new release of ``networkx`` - Update the release notes: - 1. Review and cleanup ``doc/release/release_dev.txt``. + 1. Review and cleanup ``doc/release/release_dev.txt``, - 2. Make a list of merges and contributors by running + 2. Fix code in documentation by running + ``cd doc && make doctest``. + + 3. Make a list of merges and contributors by running ``doc/release/contribs.py <tag of previous release>``. - 3. Paste this list at the end of the ``release_dev.txt``. Scan the PR titles + 4. Paste this list at the end of the ``release_dev.txt``. Scan the PR titles for highlights, deprecations, and API changes, and mention these in the relevant sections of the notes. - 4. Rename to ``doc/release/release_<major>.<minor>.txt`` + 5. Rename to ``doc/release/release_<major>.<minor>.txt``. - 5. Copy ``doc/release/release_template.txt`` to + 6. Copy ``doc/release/release_template.txt`` to ``doc/release/release_dev.txt`` for the next release. + 7. Update ``doc/news.rst``. + - Toggle ``dev = True`` to ``dev = False`` in ``networkx/release.py``. - Add the version number as a tag in git:: |