diff options
author | Charles Harris <charlesr.harris@gmail.com> | 2016-01-16 09:38:06 -0700 |
---|---|---|
committer | Charles Harris <charlesr.harris@gmail.com> | 2016-01-16 09:38:06 -0700 |
commit | 0f72920972dd2935991f839b0872d8fcca65c079 (patch) | |
tree | 0074703c60f63a55929af610f00980d13dceb947 /doc | |
parent | 880e323c94cdeab665c70b1ae3fbd4c9cd9f9c09 (diff) | |
parent | ab5c6d01da88c05255427a8b6db72c66f67c849a (diff) | |
download | numpy-0f72920972dd2935991f839b0872d8fcca65c079.tar.gz |
Merge pull request #6895 from rgommers/packaging
BLD: build improvements (enable setuptools)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/HOWTO_BUILD_DOCS.rst.txt | 4 | ||||
-rw-r--r-- | doc/Makefile | 2 | ||||
-rw-r--r-- | doc/source/dev/development_environment.rst | 6 | ||||
-rw-r--r-- | doc/source/reference/routines.other.rst | 7 | ||||
-rw-r--r-- | doc/source/user/building.rst | 16 | ||||
-rw-r--r-- | doc/source/user/install.rst | 5 |
6 files changed, 23 insertions, 17 deletions
diff --git a/doc/HOWTO_BUILD_DOCS.rst.txt b/doc/HOWTO_BUILD_DOCS.rst.txt index 8107aaa81..dc0145855 100644 --- a/doc/HOWTO_BUILD_DOCS.rst.txt +++ b/doc/HOWTO_BUILD_DOCS.rst.txt @@ -36,9 +36,7 @@ that the correct version is imported by >>> import numpy Note that you can eg. install Numpy to a temporary location and set -the PYTHONPATH environment variable appropriately. Also note that if -you have a system Numpy installed via Python eggs, you will also need -to use ``setupegg.py`` to install the temporary Numpy. +the PYTHONPATH environment variable appropriately. After Numpy is installed, write:: diff --git a/doc/Makefile b/doc/Makefile index 063ab0db8..52840be92 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -82,7 +82,7 @@ real-dist: dist-build html html-scipyorg dist-build: rm -f ../dist/*.egg - cd .. && $(PYTHON) setupegg.py bdist_egg + cd .. && $(PYTHON) setup.py bdist_egg install -d $(subst :, ,$(INSTALL_PPH)) $(PYTHON) `which easy_install` --prefix=$(INSTALL_DIR) ../dist/*.egg diff --git a/doc/source/dev/development_environment.rst b/doc/source/dev/development_environment.rst index 0fb5a666d..f3f24aab7 100644 --- a/doc/source/dev/development_environment.rst +++ b/doc/source/dev/development_environment.rst @@ -62,9 +62,9 @@ test and use your changes (in ``.py`` files), by simply restarting the interpreter. Note that another way to do an inplace build visible outside the repo base dir -is with ``python setup.py develop``. This doesn't work for NumPy, because -NumPy builds don't use ``setuptools`` by default. ``python setupegg.py -develop`` will work though. +is with ``python setup.py develop``. Instead of adjusting ``PYTHONPATH``, this +installs a ``.egg-link`` file into your site-packages as well as adjusts the +``easy-install.pth`` there, so its a more permanent (and magical) operation. Other build options diff --git a/doc/source/reference/routines.other.rst b/doc/source/reference/routines.other.rst index a3a1f8a06..b7a924eba 100644 --- a/doc/source/reference/routines.other.rst +++ b/doc/source/reference/routines.other.rst @@ -31,3 +31,10 @@ Memory ranges shares_memory may_share_memory + +Numpy version comparison +------------------------ +.. autosummary:: + :toctree: generated/ + + lib.NumpyVersion diff --git a/doc/source/user/building.rst b/doc/source/user/building.rst index 8acb2fa3b..78dbc9fa2 100644 --- a/doc/source/user/building.rst +++ b/doc/source/user/building.rst @@ -45,6 +45,12 @@ Building NumPy requires the following software installed: can be used, including optimized LAPACK libraries such as ATLAS, MKL or the Accelerate/vecLib framework on OS X. +4) Cython + + To build development versions of Numpy, you'll need a recent version of + Cython. Released Numpy sources on PyPi include the C files generated from + Cython code, so for released versions having Cython installed isn't needed. + Basic Installation ------------------ @@ -56,9 +62,9 @@ To perform an in-place build that can be run from the source folder run:: python setup.py build_ext --inplace -The NumPy build system uses ``distutils`` and ``numpy.distutils``. -``setuptools`` is only used when building via ``pip`` or with ``python -setupegg.py``. Using ``virtualenv`` should work as expected. +The NumPy build system uses ``setuptools`` (from numpy 1.11.0, before that it +was plain ``distutils``) and ``numpy.distutils``. +Using ``virtualenv`` should work as expected. *Note: for build instructions to do development work on NumPy itself, see* :ref:`development-environment`. @@ -95,10 +101,6 @@ where different FORTRAN compilers might have been used. Choosing the fortran compiler ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -To build with g77:: - - python setup.py build --fcompiler=gnu - To build with gfortran:: python setup.py build --fcompiler=gnu95 diff --git a/doc/source/user/install.rst b/doc/source/user/install.rst index ebb6bce62..a9ac735b8 100644 --- a/doc/source/user/install.rst +++ b/doc/source/user/install.rst @@ -3,9 +3,8 @@ Installing NumPy **************** In most use cases the best way to install NumPy on your system is by using an -pre-built package for your operating system. - -Please see http://scipy.org/install.html for links to available options. +pre-built package for your operating system. Please see +http://scipy.org/install.html for links to available options. For instructions on building for source package, see :doc:`building`. This information is useful mainly for advanced users. |