diff options
| author | Ross Barnowski <rossbar@berkeley.edu> | 2020-06-29 10:53:08 -0700 |
|---|---|---|
| committer | Ross Barnowski <rossbar@berkeley.edu> | 2020-06-29 10:53:08 -0700 |
| commit | 3b51f55469a5d025eb97842c7654809bf9b937ec (patch) | |
| tree | f8c7ef7c2151bcffa5de8a434d2fc1766d91e2ab | |
| parent | 76924ed0158eab8afa59b3bea84c69924edd04f1 (diff) | |
| download | numpy-3b51f55469a5d025eb97842c7654809bf9b937ec.tar.gz | |
DOC: Add instruction about stable symlink.
Add comment to HOWTO_RELEASE about updating the stable symlink
when the minor version number is incremented.
| -rw-r--r-- | doc/HOWTO_RELEASE.rst.txt | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/HOWTO_RELEASE.rst.txt b/doc/HOWTO_RELEASE.rst.txt index bd15f7f50..5a9c4d505 100644 --- a/doc/HOWTO_RELEASE.rst.txt +++ b/doc/HOWTO_RELEASE.rst.txt @@ -390,8 +390,11 @@ create an archive of the documentation in the numpy/doc repo:: # This checks out github.com/numpy/doc and adds (``git add``) the # documentation to the checked out repo. make merge-doc - # Now edit the ``index.html`` file in the repo to reflect the new content, - # and commit the changes + # Now edit the ``index.html`` file in the repo to reflect the new content. + # If the documentation is for a non-patch release (e.g. 1.19 -> 1.20), + # make sure to update the ``stable`` symlink to point to the new directory. + ln -sfn <latest_stable_directory> stable + # Commit the changes git -C build/merge commit -am "Add documentation for <version>" # Push to numpy/doc repo git -C build/merge push |