diff options
| author | Ross Barnowski <rossbar@berkeley.edu> | 2019-12-29 15:50:36 -0800 |
|---|---|---|
| committer | Ross Barnowski <rossbar@berkeley.edu> | 2019-12-29 16:07:21 -0800 |
| commit | b9e2cdd448e10cb6aa721cf13e0a16084ab634c9 (patch) | |
| tree | 20fbfb42e6484b9626054d1f397ba3aec04be7b7 /doc | |
| parent | 49b0d2e2f71d78168eb38ea6deb52374e2227540 (diff) | |
| download | numpy-b9e2cdd448e10cb6aa721cf13e0a16084ab634c9.tar.gz | |
DOC: Added note about LaTeX requirement
Building the html docs from source requires a working LaTeX
build environment to get the equations rendered properly.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/dev/index.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/source/dev/index.rst b/doc/source/dev/index.rst index da225d8da..1aacc2c49 100644 --- a/doc/source/dev/index.rst +++ b/doc/source/dev/index.rst @@ -242,6 +242,11 @@ From the ``doc/`` directory: 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 ~~~~~~~~~~~~~~~ |