summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatti Picus <matti.picus@gmail.com>2020-06-29 22:08:14 +0300
committerGitHub <noreply@github.com>2020-06-29 22:08:14 +0300
commit19f91f3935069229bbc23bbda4294c36957901a5 (patch)
treef8c7ef7c2151bcffa5de8a434d2fc1766d91e2ab
parent76924ed0158eab8afa59b3bea84c69924edd04f1 (diff)
parent3b51f55469a5d025eb97842c7654809bf9b937ec (diff)
downloadnumpy-19f91f3935069229bbc23bbda4294c36957901a5.tar.gz
Merge pull request #16706 from rossbar/doc/release_stable_symlink
DOC: Add instruction about stable symlink
-rw-r--r--doc/HOWTO_RELEASE.rst.txt7
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