diff options
| -rw-r--r-- | Docs/source/developers/documentation.rst | 25 |
1 files changed, 20 insertions, 5 deletions
diff --git a/Docs/source/developers/documentation.rst b/Docs/source/developers/documentation.rst index 45ff4cd46..3c728a4b6 100644 --- a/Docs/source/developers/documentation.rst +++ b/Docs/source/developers/documentation.rst @@ -3,10 +3,6 @@ Documentation ============= -.. warning:: - - Needs info on how to install all pieces to compile the doc! Some basic info is in the ``CONTRIBUTING.md`` . - Doxygen documentation --------------------- @@ -47,4 +43,23 @@ Your Doxygen documentation is not only useful for people looking into the code, Exhale documentation -------------------- -Very similar to Breathe, the Python module `exhale <https://exhale.readthedocs.io/en/latest/>`__ reads the full Doxygen documentation and renders it in ` rst <https://en.wikipedia.org/wiki/ReStructuredText>`__ format, and is accessible from the main WarpX ReadTheDocs page. +Very similar to Breathe, the Python module `exhale <https://exhale.readthedocs.io/en/latest/>`__ reads the full Doxygen documentation and renders it in `rst <https://en.wikipedia.org/wiki/ReStructuredText>`__ format, and is accessible from the main WarpX ReadTheDocs page. + +Building the documentation +-------------------------- + +To build the documentation, you will need to install Doxygen as well as the Python modules `breathe` and `exhale`. On MacOS this can by done by + +.. code-block:: sh + + brew install doxygen + pip install breathe exhale + +Then, to compile the documentation, use + +.. code-block:: sh + + cd Docs/ + make html + # This will first compile the Doxygen documentation (execute doxygen) + # and then build html pages from rst files using sphinx, breathe and exhale. |