diff options
| author | Pauli Virtanen <pav@iki.fi> | 2013-07-25 13:43:34 +0300 |
|---|---|---|
| committer | Pauli Virtanen <pav@iki.fi> | 2013-07-25 18:05:11 +0300 |
| commit | fab4c0e3691da6b44b8d6a800b2677896d6e13c3 (patch) | |
| tree | 17f6e06ec69e81642dde6b94bf3b4fd5af83931a | |
| parent | 3903928a67816df6d48ed63e81ebced171252112 (diff) | |
| download | numpy-fab4c0e3691da6b44b8d6a800b2677896d6e13c3.tar.gz | |
DOC: fix HOWTO_BUILD_DOCS.rst.txt
| -rw-r--r-- | doc/HOWTO_BUILD_DOCS.rst.txt | 36 |
1 files changed, 8 insertions, 28 deletions
diff --git a/doc/HOWTO_BUILD_DOCS.rst.txt b/doc/HOWTO_BUILD_DOCS.rst.txt index d0de6d5a4..b43996899 100644 --- a/doc/HOWTO_BUILD_DOCS.rst.txt +++ b/doc/HOWTO_BUILD_DOCS.rst.txt @@ -18,6 +18,12 @@ in several different formats. Instructions ------------ +If you obtained Numpy via git, get also the git submodules that contain +additional parts required for building the documentation:: + + git submodule init + git submodule update + 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 @@ -62,34 +68,8 @@ 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. -However, if you want to make use of these extensions in third-party -projects, they are available on PyPi_ as the numpydoc_ package, and -can be installed with:: - - easy_install numpydoc - -In addition, you will need to add:: - - extensions = ['numpydoc'] - -to ``conf.py`` in your Sphinx documentation. - -The following extensions are available: - - - ``numpydoc``: support for Numpy docstring format in Sphinx. - - - ``numpydoc.only_directives``: (DEPRECATED) - - - ``numpydoc.plot_directives``: Adaptation of Matplotlib's ``plot::`` - directive. Note that this implementation may still undergo severe - changes or be eventually deprecated. - - - ``numpydoc.autosummary``: (DEPRECATED) An ``autosummary::`` directive. - Available since Sphinx 0.6 as ``sphinx.ext.autosummary``, - recommended over that included in Numpydoc since Sphinx 1.0. - - - ``numpydoc.traitsdoc``: For gathering documentation about Traits attributes. - +If you want to make use of these extensions in third-party +projects, they are available on PyPi_ as the numpydoc_ package. .. _PyPi: http://python.org/pypi .. _numpydoc: http://python.org/pypi/numpydoc |