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_BUILD_DOCS.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_BUILD_DOCS.rst.txt')
-rw-r--r-- | doc/HOWTO_BUILD_DOCS.rst.txt | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/doc/HOWTO_BUILD_DOCS.rst.txt b/doc/HOWTO_BUILD_DOCS.rst.txt index 79d76fb7d..8107aaa81 100644 --- a/doc/HOWTO_BUILD_DOCS.rst.txt +++ b/doc/HOWTO_BUILD_DOCS.rst.txt @@ -57,7 +57,7 @@ To build the PDF documentation, do instead:: You will need to have Latex installed for this. -In addition to the above, you can also do:: +Instead of the above, you can also do:: make dist @@ -65,14 +65,19 @@ which will rebuild Numpy, install it to a temporary location, and build the documentation in all formats. This will most likely again only work on Unix platforms. +The documentation for Numpy distributed at http://docs.scipy.org in html and +pdf format is also built with ``make dist``. See `HOWTO RELEASE`_ for details on +how to update http://docs.scipy.org. + .. _Matplotlib: http://matplotlib.org/ +.. _HOWTO RELEASE: https://github.com/numpy/numpy/blob/master/doc/HOWTO_RELEASE.rst.txt Sphinx extensions ----------------- Numpy's documentation uses several custom extensions to Sphinx. These -are shipped in the ``sphinxext/`` directory, and are automatically -enabled when building Numpy's documentation. +are shipped in the ``sphinxext/`` directory (as git submodules, as discussed +above), and are automatically enabled when building Numpy's documentation. If you want to make use of these extensions in third-party projects, they are available on PyPi_ as the numpydoc_ package. |