diff options
| author | Charles Harris <charlesr.harris@gmail.com> | 2017-03-26 11:30:20 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-03-26 11:30:20 -0600 |
| commit | d9347181d825d9426e783cfeafee304735bd25aa (patch) | |
| tree | b8cba9662f435de0dffa556e2911ab528ed37460 /doc/HOWTO_RELEASE.rst.txt | |
| parent | a3800c16c44e2a2ccaf621e1653aa696d3acf352 (diff) | |
| parent | fc19d055f434358de1bc95ad9e406f2abc154685 (diff) | |
| download | python-numpy-d9347181d825d9426e783cfeafee304735bd25aa.tar.gz python-numpy-d9347181d825d9426e783cfeafee304735bd25aa.tar.bz2 python-numpy-d9347181d825d9426e783cfeafee304735bd25aa.zip | |
Merge pull request #8106 from charris/release-walkthrough
WIP, DOC: Document release procedure with a walkthrough.
Diffstat (limited to 'doc/HOWTO_RELEASE.rst.txt')
| -rw-r--r-- | doc/HOWTO_RELEASE.rst.txt | 46 |
1 files changed, 38 insertions, 8 deletions
diff --git a/doc/HOWTO_RELEASE.rst.txt b/doc/HOWTO_RELEASE.rst.txt index 52c8ff56a..3ed15e99c 100644 --- a/doc/HOWTO_RELEASE.rst.txt +++ b/doc/HOWTO_RELEASE.rst.txt @@ -77,7 +77,7 @@ Tool chain We build all our wheels on cloud infrastructure - so this list of compilers is for information and debugging builds locally. See the ``.travis.yml`` and ``appveyor.yml`` scripts in the `numpy wheels`_ repo for the definitive source -of the build recipes. +of the build recipes. Packages that are available using pip are noted. Compilers --------- @@ -95,21 +95,51 @@ each platform. At the moment this means: You will need Cython for building the binaries. Cython compiles the ``.pyx`` files in the numpy distribution to ``.c`` files. -Python ------- -* Python(s) from `python.org <http://python.org>`_ -* virtualenv -* paver +Building source archives and wheels +----------------------------------- + +You will need write permission for numpy-wheels in order to trigger wheel +builds. + +* Python(s) from `python.org <http://python.org>`_ or linux distro. +* cython +* virtualenv (pip) +* Paver (pip) +* numpy-wheels `<https://github.com/MacPython/numpy-wheels>`_ (clone) Building docs ------------- -* Sphinx -* numpydoc + +Building the documents requires a number of latex ``.sty`` files. Install them +all to avoid aggravation. + +* Sphinx (pip) +* numpydoc (pip) * Matplotlib * Texlive (or MikTeX on Windows) +Uploading to PyPI +----------------- + +* terryfy `<https://github.com/MacPython/terryfy>`_ (clone). +* beautifulsoup4 (pip) +* delocate (pip) +* auditwheel (pip) +* twine (pip) + +Generating author/pr lists +-------------------------- + +You will need an personal access token +`<https://help.github.com/articles/creating-an-access-token-for-command-line-use/>`_ +so that scripts can access the github numpy repository + +* gitpython (pip) +* pygithub (pip) + Virtualenv ---------- + Virtualenv is a very useful tool to keep several versions of packages around. It is also used in the Paver script to build the docs. |