diff options
author | mattip <matti.picus@gmail.com> | 2019-07-21 08:14:54 -0400 |
---|---|---|
committer | mattip <matti.picus@gmail.com> | 2019-08-08 20:09:18 +0300 |
commit | 35c89902bc051fd2e726bc5a93e94e222ce7e690 (patch) | |
tree | 3bb4431a0d0bf9d462f4e93b27ab3071028bbcd8 /doc/HOWTO_RELEASE.rst.txt | |
parent | 5ed0ebe7ab6cfc8a0be36d40e3876d1c02946240 (diff) | |
download | numpy-35c89902bc051fd2e726bc5a93e94e222ce7e690.tar.gz |
BUILD, DOC: add merge-doc target to update the numpy/doc repo
Diffstat (limited to 'doc/HOWTO_RELEASE.rst.txt')
-rw-r--r-- | doc/HOWTO_RELEASE.rst.txt | 52 |
1 files changed, 19 insertions, 33 deletions
diff --git a/doc/HOWTO_RELEASE.rst.txt b/doc/HOWTO_RELEASE.rst.txt index 15ae2c2a1..4b485c8b9 100644 --- a/doc/HOWTO_RELEASE.rst.txt +++ b/doc/HOWTO_RELEASE.rst.txt @@ -197,17 +197,6 @@ best to read the pavement.py script. .. note:: The following steps are repeated for the beta(s), release candidates(s) and the final release. -Check that docs can be built ----------------------------- -Do:: - - cd doc/ - make dist - -to check that the documentation is in a buildable state. See -doc/HOWTO_BUILD_DOCS.rst.txt for more details and for how to update -https://docs.scipy.org. - Check deprecations ------------------ Before the release branch is made, it should be checked that all deprecated @@ -389,6 +378,25 @@ Build the changelog and notes for upload with:: paver write_release_and_log +Build and archive documentation +------------------------------- +Do:: + + cd doc/ + make dist + +to check that the documentation is in a buildable state. Then, after tagging, +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 + git -C dist/merge commit -a "Add documentation for <version>" + # Push to numpy/doc repo + git -C push + Update PyPI ----------- @@ -440,28 +448,6 @@ you released you can push the tag and release commit up to github:: where ``upstream`` points to the main https://github.com/numpy/numpy.git repository. -Update docs.scipy.org ---------------------- - -All documentation for a release can be updated on https://docs.scipy.org/ with: - - make dist - make upload USERNAME=<yourname> RELEASE=1.11.0 - -Note that ``<username>`` must have SSH credentials on the server. If you don't -have those, ask someone who does (the list currently includes @rgommers, -@juliantaylor and @pv). - -Also rebuild and upload ``docs.scipy.org`` front page, if the release -series is a new one. The front page sources have their own repo: -https://github.com/scipy/docs.scipy.org. Do the following: - -- Update ``index.rst`` for the new version. -- ``make dist`` -- Check that the built documentation is OK. -- ``touch output-is-fine`` -- ``make upload USERNAME=<username> RELEASE=1.x.y`` - Update scipy.org ---------------- |