diff options
author | Ralf Gommers <ralf.gommers@gmail.com> | 2019-12-30 06:49:54 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-12-30 06:49:54 +0100 |
commit | 769460c17550921b4a192f410c49b03f4ff83766 (patch) | |
tree | 20fbfb42e6484b9626054d1f397ba3aec04be7b7 | |
parent | c18b3f59b5f5752ab038224fd3bdf2dadba55ecf (diff) | |
parent | b9e2cdd448e10cb6aa721cf13e0a16084ab634c9 (diff) | |
download | numpy-769460c17550921b4a192f410c49b03f4ff83766.tar.gz |
Merge pull request #15196 from rossbar/doc/build_instructions
DOC: Adding instructions for building documentation to developer guide
-rw-r--r-- | doc/source/dev/index.rst | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/source/dev/index.rst b/doc/source/dev/index.rst index 306c15069..1aacc2c49 100644 --- a/doc/source/dev/index.rst +++ b/doc/source/dev/index.rst @@ -231,6 +231,22 @@ 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 + +The documentation includes mathematical formulae with LaTeX formatting. +A working LaTeX document production system +(e.g. `texlive <https://www.tug.org/texlive/>`__) is required for the +proper rendering of the LaTeX math in the documentation. + Fixing Warnings ~~~~~~~~~~~~~~~ |