summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRoss Barnowski <rossbar@berkeley.edu>2019-12-29 15:16:46 -0800
committerRoss Barnowski <rossbar@berkeley.edu>2019-12-29 16:05:50 -0800
commit49b0d2e2f71d78168eb38ea6deb52374e2227540 (patch)
tree32934e13380590a44c88162fd47f6d8113319053 /doc
parentc18b3f59b5f5752ab038224fd3bdf2dadba55ecf (diff)
downloadnumpy-49b0d2e2f71d78168eb38ea6deb52374e2227540.tar.gz
DOC: Initialize submodules to build docs.
Added instructions to the developer guide on initializing the submodules containing numpydoc and the scipy sphinx theme before building the documentation.
Diffstat (limited to 'doc')
-rw-r--r--doc/source/dev/index.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/source/dev/index.rst b/doc/source/dev/index.rst
index 306c15069..da225d8da 100644
--- a/doc/source/dev/index.rst
+++ b/doc/source/dev/index.rst
@@ -231,6 +231,17 @@ Requirements
`Sphinx <http://www.sphinx-doc.org/en/stable/>`__ is needed to build
the documentation. Matplotlib, SciPy, and IPython are also required.
+The numpy documentation also depends on the
+`numpydoc <https://numpydoc.readthedocs.io/en/latest/>`__ sphinx extension
+as well as an external sphinx theme.
+These extensions are included as git submodules and must be initialized
+before building the docs.
+From the ``doc/`` directory:
+
+.. code:: sh
+
+ git submodule update --init
+
Fixing Warnings
~~~~~~~~~~~~~~~