summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/DISTUTILS.rst.txt2
-rw-r--r--doc/HOWTO_RELEASE.rst.txt38
-rw-r--r--doc/RELEASE_WALKTHROUGH.rst.txt34
-rw-r--r--doc/neps/nep-0010-new-iterator-ufunc.rst2
-rw-r--r--doc/neps/nep-0012-missing-data.rst2
-rw-r--r--doc/neps/nep-0028-website-redesign.rst2
-rw-r--r--doc/neps/nep-0040-legacy-datatype-impl.rst6
-rw-r--r--doc/neps/scope.rst2
-rw-r--r--doc/source/dev/index.rst2
-rw-r--r--doc/source/reference/c-api/array.rst2
-rw-r--r--doc/source/user/tutorial-svd.rst2
11 files changed, 46 insertions, 48 deletions
diff --git a/doc/DISTUTILS.rst.txt b/doc/DISTUTILS.rst.txt
index 2957bb907..15073f754 100644
--- a/doc/DISTUTILS.rst.txt
+++ b/doc/DISTUTILS.rst.txt
@@ -345,7 +345,7 @@ expression, '<...>' will be replaced first with item1, and then with
item2, and so forth until N repeats are accomplished. Once a named
repeat specification has been introduced, the same repeat rule may be
used **in the current block** by referring only to the name
-(i.e. <rule1>.
+(i.e. <rule1>).
Short repeat rule
diff --git a/doc/HOWTO_RELEASE.rst.txt b/doc/HOWTO_RELEASE.rst.txt
index 79a6830c4..6af8d9ca6 100644
--- a/doc/HOWTO_RELEASE.rst.txt
+++ b/doc/HOWTO_RELEASE.rst.txt
@@ -352,36 +352,30 @@ Also create a new version hash in cversions.txt and a corresponding version
define NPY_x_y_API_VERSION in numpyconfig.h
-Trigger the wheel builds on travis-ci and Appveyor
---------------------------------------------------
-See the `numpy wheels` repository.
+Trigger the wheel builds
+------------------------
+See the `MacPython/numpy wheels` repository.
In that repository edit the files:
-- ``.travis.yml``;
-- ``appveyor.yml``.
+- ``azure/posix.yml``
+- ``azure/windows.yml``.
In both cases, set the ``BUILD_COMMIT`` variable to the current release tag -
-e.g. ``v1.11.1``.
+e.g. ``v1.19.0``::
-Make sure that the release tag has been pushed.
-
-Trigger a build by doing a commit of your edits to ``.travis.yml`` and
-``appveyor.yml`` to the repository::
-
- cd /path/to/numpy-wheels
- # Edit .travis.yml, appveyor.yml
- git commit
- git push
+ $ gvim azure/posix.yml azure/windows.yml
+ $ git commit -a
+ $ git push upstream HEAD
-The wheels, once built, appear at a Rackspace container pointed at by:
-
-- http://wheels.scipy.org
-- https://3f23b170c54c2533c070-1c8a9b3114517dc5fe17b7c3f8c63a43.ssl.cf2.rackcdn.com
+Make sure that the release tag has been pushed.
-The HTTP address may update first, and you should wait 15 minutes after the
-build finishes before fetching the binaries.
+Trigger a build by pushing a commit of your edits to the repository. Note that
+you can do this on a branch, but it must be pushed upstream to the
+``MacPython/numpy-wheels`` repository to trigger uploads since only
+that repo has the appropriate tokens to allow uploads.
+The wheels, once built, appear at https://anaconda.org/multibuild-wheels-staging/numpy
Make the release
----------------
@@ -423,7 +417,7 @@ https://github.com/MacPython/terryfy. Here is the recommended incantation for
downloading all the Windows, Manylinux, OSX wheels and uploading to PyPI. ::
NPY_WHLS=~/wheelhouse # local directory to cache wheel downloads
- CDN_URL=https://3f23b170c54c2533c070-1c8a9b3114517dc5fe17b7c3f8c63a43.ssl.cf2.rackcdn.com
+ CDN_URL=https://anaconda.org/multibuild-wheels-staging/numpy/files
wheel-uploader -u $CDN_URL -w $NPY_WHLS -v -s -t win numpy 1.11.1rc1
wheel-uploader -u $CDN_URL -w warehouse -v -s -t macosx numpy 1.11.1rc1
wheel-uploader -u $CDN_URL -w warehouse -v -s -t manylinux1 numpy 1.11.1rc1
diff --git a/doc/RELEASE_WALKTHROUGH.rst.txt b/doc/RELEASE_WALKTHROUGH.rst.txt
index bae4b838d..0ff9ff933 100644
--- a/doc/RELEASE_WALKTHROUGH.rst.txt
+++ b/doc/RELEASE_WALKTHROUGH.rst.txt
@@ -1,7 +1,10 @@
-This file contains a walkthrough of the NumPy 1.14.5 release on Linux.
+This file contains a walkthrough of the NumPy 1.14.5 release on Linux, modified
+for building on azure and uploading to anaconda.org
The commands can be copied into the command line, but be sure to
replace 1.14.5 by the correct version.
+This should be read together with the general directions in `releasing`.
+
Release Walkthrough
====================
@@ -90,7 +93,7 @@ Build wheels
------------
Trigger the wheels build by pointing the numpy-wheels repository at this
-commit. This can take a while. The numpy-wheels repository is cloned from
+commit. This can take up to an hour. The numpy-wheels repository is cloned from
`<https://github.com/MacPython/numpy-wheels>`_. Start with a pull as the repo
may have been accessed and changed by someone else and a push will fail::
@@ -99,25 +102,26 @@ may have been accessed and changed by someone else and a push will fail::
$ git branch <new version> # only when starting new numpy version
$ git checkout v1.14.x # v1.14.x already existed for the 1.14.4 release
-Edit the ``.travis.yml`` and ``.appveyor.yml`` files to make sure they have the
-correct version, and put in the commit hash for the ``REL`` commit created
-above for ``BUILD_COMMIT``, see the _example from `v1.14.3`::
+Edit the ``azure/posix.yml`` and ``azure/windows.yml`` files to make sure they
+have the correct version, and put in the commit hash for the ``REL`` commit
+created above for ``BUILD_COMMIT``, see an _example::
- $ gvim .travis.yml .appveyor.yml
+ $ gvim azure/posix.yml azure/windows.yml
$ git commit -a
$ git push upstream HEAD
Now wait. If you get nervous at the amount of time taken -- the builds can take
-several hours-- you can check the build progress by following the links
-provided at `<https://github.com/MacPython/numpy-wheels>`_ to check the travis
-and appveyor build status. Check if all the needed wheels have been built and
-uploaded before proceeding. There should currently be 22 of them at
-`<https://wheels.scipy.org>`_, 4 for Mac, 8 for Windows, and 10 for Linux.
-Note that sometimes builds, like tests, fail for unrelated reasons and you will
-need to restart them.
+a while -- you can check the build progress by following the links
+provided at `<https://github.com/MacPython/numpy-wheels>`_ to check the
+build status. Check if all the needed wheels have been built and
+uploaded before proceeding. There should currently be 21 of them at
+`<https://anaconda.org/multibuild-wheels-staging/numpy/files>`_, 3 for Mac, 6
+for Windows, and 12 for Linux.
-.. example_: https://github.com/MacPython/numpy-wheels/commit/fed9c04629c155e7804282eb803d81097244598d
+.. example_: https://github.com/MacPython/numpy-wheels/pull/80/commits/cbf4af4
+Note that sometimes builds, like tests, fail for unrelated reasons and
+you will need to restart them.
Download wheels
---------------
@@ -131,7 +135,7 @@ upload later using ``twine``::
$ cd ../terryfy
$ git pull upstream master
- $ CDN_URL=https://3f23b170c54c2533c070-1c8a9b3114517dc5fe17b7c3f8c63a43.ssl.cf2.rackcdn.com
+ $ CDN_URL=https://anaconda.org/multibuild-wheels-staging/numpy/files
$ NPY_WHLS=../numpy/release/installers
$ ./wheel-uploader -u $CDN_URL -n -v -w $NPY_WHLS -t win numpy 1.14.5
$ ./wheel-uploader -u $CDN_URL -n -v -w $NPY_WHLS -t manylinux1 numpy 1.14.5
diff --git a/doc/neps/nep-0010-new-iterator-ufunc.rst b/doc/neps/nep-0010-new-iterator-ufunc.rst
index fd7b3e52c..7a2a272f4 100644
--- a/doc/neps/nep-0010-new-iterator-ufunc.rst
+++ b/doc/neps/nep-0010-new-iterator-ufunc.rst
@@ -1291,7 +1291,7 @@ Construction and Destruction
Returns ``NPY_SUCCEED`` or ``NPY_FAIL``.
-``int NpyIter_HasInnerLoop(NpyIter *iter``
+``int NpyIter_HasInnerLoop(NpyIter *iter)``
Returns 1 if the iterator handles the inner loop,
or 0 if the caller needs to handle it. This is controlled
diff --git a/doc/neps/nep-0012-missing-data.rst b/doc/neps/nep-0012-missing-data.rst
index dbcf1b579..f59cf394f 100644
--- a/doc/neps/nep-0012-missing-data.rst
+++ b/doc/neps/nep-0012-missing-data.rst
@@ -313,7 +313,7 @@ The following works in the current draft implementation::
For floating point numbers, Inf and NaN are separate concepts from
missing values. If a division by zero occurs in an array with default
missing value support, an unmasked Inf or NaN will be produced. To
-mask those values, a further 'a[np.logical_not(a.isfinite(a)] = np.NA'
+mask those values, a further 'a[np.logical_not(a.isfinite(a))] = np.NA'
can achieve that. For the bitpattern approach, the parameterized
dtype('NA[f8,InfNan]') described in a later section can be used to get
these semantics without the extra manipulation.
diff --git a/doc/neps/nep-0028-website-redesign.rst b/doc/neps/nep-0028-website-redesign.rst
index dcd182d55..022a1fdbb 100644
--- a/doc/neps/nep-0028-website-redesign.rst
+++ b/doc/neps/nep-0028-website-redesign.rst
@@ -131,7 +131,7 @@ Possible options for static site generators
Unlike the previous options, Docusaurus doesn't come with themes, and thus we
would not want to use this for our landing page. This is an excellent docs
option written in React. Docusaurus natively has support for i18n (via
- Crowdin_, document versioning, and document search.
+ Crowdin_), document versioning, and document search.
Both Jekyll and Hugo are excellent options that should be supported into the
future and are good choices for NumPy. Docusaurus has several bonus features
diff --git a/doc/neps/nep-0040-legacy-datatype-impl.rst b/doc/neps/nep-0040-legacy-datatype-impl.rst
index 799c6c026..c9a4fd7c8 100644
--- a/doc/neps/nep-0040-legacy-datatype-impl.rst
+++ b/doc/neps/nep-0040-legacy-datatype-impl.rst
@@ -180,8 +180,8 @@ These issues do not need to solved right away:
scalars behave much like NumPy arrays, a feature that general Python objects
do not have.
* Seamless integration probably requires that ``np.array(scalar)`` finds the
- correct DType automatically since some operations (such as indexing) are
- return the scalar instead of a 0D array.
+ correct DType automatically since some operations (such as indexing) return
+ the scalar instead of a 0D array.
This is problematic if multiple users independently decide to implement
for example a DType for ``decimal.Decimal``.
@@ -207,7 +207,7 @@ Many datatype-specific functions are defined within a C structure called
:c:type:`PyArray_ArrFuncs`, which is part of each ``dtype`` instance and
has a similarity to Python's ``PyNumberMethods``.
For user-defined datatypes this structure is exposed to the user, making
-ABI-compatible changes changes impossible.
+ABI-compatible changes impossible.
This structure holds important information such as how to copy or cast,
and provides space for pointers to functions, such as comparing elements,
converting to bool, or sorting.
diff --git a/doc/neps/scope.rst b/doc/neps/scope.rst
index a675b8c96..61eab2ea6 100644
--- a/doc/neps/scope.rst
+++ b/doc/neps/scope.rst
@@ -35,7 +35,7 @@ Here, we describe aspects of N-d array computation that are within scope for Num
- NumPy provides some **infrastructure for other packages in the scientific Python ecosystem**:
- - numpy.distutils (build support for C++, Fortran, BLAS/LAPACK, and other relevant libraries for scientific computing
+ - numpy.distutils (build support for C++, Fortran, BLAS/LAPACK, and other relevant libraries for scientific computing)
- f2py (generating bindings for Fortran code)
- testing utilities
diff --git a/doc/source/dev/index.rst b/doc/source/dev/index.rst
index c3f880a35..dc6099992 100644
--- a/doc/source/dev/index.rst
+++ b/doc/source/dev/index.rst
@@ -84,7 +84,7 @@ Here's the short summary, complete TOC links are below:
* Enter your GitHub username and password (repeat contributors or advanced
users can remove this step by connecting to GitHub with
- :ref:`SSH<set-up-and-configure-a-github-account>` .
+ :ref:`SSH<set-up-and-configure-a-github-account>`).
* Go to GitHub. The new branch will show up with a green Pull Request
button. Make sure the title and message are clear, concise, and self-
diff --git a/doc/source/reference/c-api/array.rst b/doc/source/reference/c-api/array.rst
index 22b15fc57..83289010b 100644
--- a/doc/source/reference/c-api/array.rst
+++ b/doc/source/reference/c-api/array.rst
@@ -3026,7 +3026,7 @@ Other conversions
.. code-block:: c
- #define error_converting(x) (((x) == -1) && PyErr_Occurred()
+ #define error_converting(x) (((x) == -1) && PyErr_Occurred())
.. c:function:: npy_intp PyArray_PyIntAsIntp(PyObject* op)
diff --git a/doc/source/user/tutorial-svd.rst b/doc/source/user/tutorial-svd.rst
index e1918f394..086e0a6de 100644
--- a/doc/source/user/tutorial-svd.rst
+++ b/doc/source/user/tutorial-svd.rst
@@ -455,7 +455,7 @@ and
:include-source: 0
should give you an image indistinguishable from the original one (although we
-may introduce floating point errors for this reconstruction. In fact,
+may introduce floating point errors for this reconstruction). In fact,
you might see a warning message saying `"Clipping input data to the
valid range for imshow with RGB data ([0..1] for floats or [0..255] for
integers)."` This is expected from the manipulation we just did on the original