summaryrefslogtreecommitdiff
path: root/doc/source/dev/howto_build_docs.rst
diff options
context:
space:
mode:
authorSayantika Banik <sayantikabanik122@gmail.com>2021-09-08 06:21:36 +0000
committerSayantika Banik <sayantikabanik122@gmail.com>2021-09-08 06:21:36 +0000
commit879b3b4798975c7c0c49cef6ece3563c5f2daaeb (patch)
treee102f2222f1557d9b4f8b1a3e9484ca59b8ad954 /doc/source/dev/howto_build_docs.rst
parent9680d760cdb08cc54c18657c77269853670f17e9 (diff)
parent17c3a6b414a3e642abeb116ff71e97f9b6f2aab5 (diff)
downloadnumpy-879b3b4798975c7c0c49cef6ece3563c5f2daaeb.tar.gz
Merge branch 'main' of https://github.com/sayantikabanik/numpy
Diffstat (limited to 'doc/source/dev/howto_build_docs.rst')
-rw-r--r--doc/source/dev/howto_build_docs.rst21
1 files changed, 16 insertions, 5 deletions
diff --git a/doc/source/dev/howto_build_docs.rst b/doc/source/dev/howto_build_docs.rst
index 884cf7935..b175926da 100644
--- a/doc/source/dev/howto_build_docs.rst
+++ b/doc/source/dev/howto_build_docs.rst
@@ -58,18 +58,28 @@ new virtual environment is recommended.
Dependencies
^^^^^^^^^^^^
-All of the necessary dependencies for building the NumPy docs can be installed
-with::
+All of the necessary dependencies for building the NumPy docs except for
+Doxygen_ can be installed with::
pip install -r doc_requirements.txt
-We currently use Sphinx_ for generating the API and reference
-documentation for NumPy. In addition, building the documentation requires
-the Sphinx extension `plot_directive`, which is shipped with
+We currently use Sphinx_ along with Doxygen_ for generating the API and
+reference documentation for NumPy. In addition, building the documentation
+requires the Sphinx extension `plot_directive`, which is shipped with
:doc:`Matplotlib <matplotlib:index>`. We also use numpydoc_ to render docstrings in
the generated API documentation. :doc:`SciPy <scipy:index>`
is installed since some parts of the documentation require SciPy functions.
+For installing Doxygen_, please check the official
+`download <https://www.doxygen.nl/download.html#srcbin>`_ and
+`installation <https://www.doxygen.nl/manual/install.html>`_ pages, or if you
+are using Linux then you can install it through your distribution package manager.
+
+.. note::
+
+ Try to install a newer version of Doxygen_ > 1.8.10 otherwise you may get some
+ warnings during the build.
+
Submodules
^^^^^^^^^^
@@ -80,6 +90,7 @@ additional parts required for building the documentation::
.. _Sphinx: http://www.sphinx-doc.org/
.. _numpydoc: https://numpydoc.readthedocs.io/en/latest/index.html
+.. _Doxygen: https://www.doxygen.nl/index.html
Instructions
------------