diff options
author | Ralf Gommers <ralf.gommers@gmail.com> | 2015-10-19 07:52:39 +0200 |
---|---|---|
committer | Ralf Gommers <ralf.gommers@gmail.com> | 2015-10-19 07:57:18 +0200 |
commit | d75b44a32bc13bd457f756b6fdeebd8f12b21799 (patch) | |
tree | 9ff262244e48c3f083124d92b01ccf65c0076a60 /doc/HOWTO_RELEASE.rst.txt | |
parent | 0b83a90f5e6157ced66792c3de6f68436ee96e05 (diff) | |
download | numpy-d75b44a32bc13bd457f756b6fdeebd8f12b21799.tar.gz |
DOC: update HOWTO_BUILD_DOCS and HOWTO_RELEASE for release doc builds.
[ci skip]
Diffstat (limited to 'doc/HOWTO_RELEASE.rst.txt')
-rw-r--r-- | doc/HOWTO_RELEASE.rst.txt | 40 |
1 files changed, 18 insertions, 22 deletions
diff --git a/doc/HOWTO_RELEASE.rst.txt b/doc/HOWTO_RELEASE.rst.txt index 5fed523c1..b77a6c25c 100644 --- a/doc/HOWTO_RELEASE.rst.txt +++ b/doc/HOWTO_RELEASE.rst.txt @@ -32,7 +32,7 @@ Doc wiki Release Scripts --------------- -* https://github.com/certik/numpy-vendor +* https://github.com/numpy/numpy-vendor Supported platforms and versions @@ -217,7 +217,9 @@ Do:: cd doc/ make dist -to check that the documentation is in a buildable state. +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 +http://docs.scipy.org. Check deprecations ------------------ @@ -292,9 +294,11 @@ Now, set ``release=True`` in setup.py, then :: git commit -m "REL: Release." setup.py - git tag <version> + git tag -s <version> git push origin <version> +Note: ``git tag -s`` creates a signed tag - make sure your PGP key is public. + Apply patch to fix bogus strides -------------------------------- NPY_RELAXED_STRIDE_CHECKING was made the default in Numpy 1.10 and bogus @@ -336,32 +340,24 @@ works. Update docs.scipy.org --------------------- -Do the following (or ask the doc people to take care of it): - -Rebuild and upload documentation: +All documentation for a release can be updated on http://docs.scipy.org/ with: -- ``cd numpy/doc`` -- ``make dist`` -- Check that the built documentation is OK. -- ``touch output-is-fine`` -- ``make upload UPLOAD_TARGET=USERNAME@docs.scipy.org:/home/docserver/www-root/doc/numpy-1.5.x/`` + make dist + make upload USERNAME=<yourname> RELEASE=1.11.0 -where USERNAME should be replaced by your account on -``docs.scipy.org``, and ``numpy-1.5.x`` by the version number of the -*release series*. For instance, for Numpy 1.5.1, it should be -``numpy-1.5.x`` and for Numpy 2.0.0 ``numpy-2.0.x``. +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). -Rebuild and upload ``docs.scipy.org`` front page, if the release -series is a new one. The front page sources are located in the Scipy -repository: +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: -- ``cd scipy/doc/frontpage`` -- Edit ``_templates/indexcontent.html`` to add links to the new release series. +- Update ``index.rst`` for the new version. - ``make dist`` - Check that the built documentation is OK. - ``touch output-is-fine`` -- ``make upload USER=USERNAME`` - +- ``make upload USERNAME=<username> RELEASE=1.x.y`` Update scipy.org ---------------- |