diff options
author | Sayed Adel <seiko@imavr.com> | 2021-07-13 23:37:25 +0200 |
---|---|---|
committer | Sayed Adel <seiko@imavr.com> | 2021-08-30 21:01:46 +0200 |
commit | a7d3a77121f0127b9402a78b1138d00dd4f973fc (patch) | |
tree | 48f78a6a1b7eee64fdb3875d3a45f1e8b25b8fef /doc/source/dev/howto_build_docs.rst | |
parent | 7028aec45baf553b8d8a6aec12ac3167a9b3a962 (diff) | |
download | numpy-a7d3a77121f0127b9402a78b1138d00dd4f973fc.tar.gz |
DOC: Add support for documenting C/C++ via Doxygen & Breathe
Diffstat (limited to 'doc/source/dev/howto_build_docs.rst')
-rw-r--r-- | doc/source/dev/howto_build_docs.rst | 21 |
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 ------------ |