diff options
author | mattip <matti.picus@gmail.com> | 2019-07-14 12:07:32 -0500 |
---|---|---|
committer | mattip <matti.picus@gmail.com> | 2019-07-14 12:07:32 -0500 |
commit | 9e620274aee17021a3e6cda29f8b3a08d04ce446 (patch) | |
tree | b484815d4730ec07b3e0ebabc09d97a3412618ff /doc/source/docs | |
parent | 5b0069c08d00e871d74c6533e0b0eeb3107e8f70 (diff) | |
download | numpy-9e620274aee17021a3e6cda29f8b3a08d04ce446.tar.gz |
DOC: emphasize need for matching numpy, git versions
Diffstat (limited to 'doc/source/docs')
-rw-r--r-- | doc/source/docs/howto_build_docs.rst | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/doc/source/docs/howto_build_docs.rst b/doc/source/docs/howto_build_docs.rst index 98d1b88ba..4bb7628c1 100644 --- a/doc/source/docs/howto_build_docs.rst +++ b/doc/source/docs/howto_build_docs.rst @@ -30,11 +30,9 @@ In addition, building the documentation requires the Sphinx extension `plot_directive`, which is shipped with Matplotlib_. This Sphinx extension can be installed by installing Matplotlib. You will also need python3.6. -Since large parts of the main documentation are stored in -docstrings, you will need to first build NumPy, and install it so -that the correct version is imported by - - >>> import numpy +Since large parts of the main documentation are obtained from numpy via +``import numpy`` and examining the docstrings, you will need to first build +NumPy, and install it so that the correct version is imported. Note that you can eg. install NumPy to a temporary location and set the PYTHONPATH environment variable appropriately. @@ -46,8 +44,11 @@ generate the docs, so write:: make html in the ``doc/`` directory. If all goes well, this will generate a -``build/html`` subdirectory containing the built documentation. Note -that building the documentation on Windows is currently not actively +``build/html`` subdirectory containing the built documentation. If you get +a message about ``installed numpy != current repo git version``, you must +either override the check by setting ``GITVER`` or re-install NumPy. + +Note that building the documentation on Windows is currently not actively supported, though it should be possible. (See Sphinx_ documentation for more information.) |