diff options
| author |  Dave Grote <grote1@llnl.gov>
| 2020-01-09 15:45:49 -0800 |
|---|---|---|
| committer | Dave Grote <grote1@llnl.gov>
| 2020-01-09 15:45:49 -0800 |
| commit | 8f23eb12d388e55dc7f1cc0b9fc426380fa1740c (patch) | |
| tree | a46a0e235f266b9a349f10448f8c5eb9268d832a /Docs/source/developers | |
| parent | e93fd4ee732826df82f6fd942b27b81daa7dbff4 (diff) | |
| parent | 0b25b1b68f1b70e965295505d1503a3e57b6c2cc (diff) | |
| download | WarpX-8f23eb12d388e55dc7f1cc0b9fc426380fa1740c.tar.gz WarpX-8f23eb12d388e55dc7f1cc0b9fc426380fa1740c.tar.zst WarpX-8f23eb12d388e55dc7f1cc0b9fc426380fa1740c.zip | |
Merge remote-tracking branch 'ECPwarpx/dev' into fix_picmi_diagnostics
Diffstat (limited to 'Docs/source/developers')
| -rw-r--r-- | Docs/source/developers/developers.rst | 2 | ||||
| -rw-r--r-- | Docs/source/developers/documentation.rst | 2 |
2 files changed, 4 insertions, 0 deletions
diff --git a/Docs/source/developers/developers.rst b/Docs/source/developers/developers.rst index 4eab0102a..777c2f77b 100644 --- a/Docs/source/developers/developers.rst +++ b/Docs/source/developers/developers.rst @@ -5,6 +5,8 @@ Developers documentation For general information on how to contribute to WarpX, including our ``git`` workflow and code practices, have a look at our `CONTRIBUTING.md <https://github.com/ECP-WarpX/WarpX/blob/dev/CONTRIBUTING.md>`__! +Our Doxygen API documentation in classic formatting `is located here <../_static/doxyhtml/index.html>`_. + .. toctree:: :maxdepth: 1 diff --git a/Docs/source/developers/documentation.rst b/Docs/source/developers/documentation.rst index a6f06c7bd..45ff4cd46 100644 --- a/Docs/source/developers/documentation.rst +++ b/Docs/source/developers/documentation.rst @@ -35,6 +35,8 @@ Doxygen reads this docstring, so please be accurate with the syntax! See `Doxyge */ void my_class::my_function(int* my_int); +A HTML rendered version of the Doxygen documentation `is located here <../_static/doxyhtml/index.html>`_. + Breathe documentation --------------------- |