diff options
| author |  Axel Huebl <axel.huebl@plasma.ninja>
| 2022-05-11 11:48:49 -0700 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2022-05-11 11:48:49 -0700 |
| commit | e836ce9cfd40432bff46fe9c58b3e8c2d2f9f284 (patch) | |
| tree | bdc8ada77a07302f10efb8bc8a0b992c55e8bc32 /Docs/source/developers/doxygen.rst | |
| parent | cfd9249ae17ef8450aa5dd0327793b7f6e720501 (diff) | |
| download | WarpX-e836ce9cfd40432bff46fe9c58b3e8c2d2f9f284.tar.gz WarpX-e836ce9cfd40432bff46fe9c58b3e8c2d2f9f284.tar.zst WarpX-e836ce9cfd40432bff46fe9c58b3e8c2d2f9f284.zip | |
Doc: Improve Doxygen Links (#3099)
* Doc: Improve Doxygen Links
- download also openPMD-api tag files & link them
- improve developer page: clearer links
* Update: .gitignore
Diffstat (limited to 'Docs/source/developers/doxygen.rst')
| -rw-r--r-- | Docs/source/developers/doxygen.rst | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/Docs/source/developers/doxygen.rst b/Docs/source/developers/doxygen.rst index 4d50cbc1f..3580d8b24 100644 --- a/Docs/source/developers/doxygen.rst +++ b/Docs/source/developers/doxygen.rst @@ -5,4 +5,10 @@ C++ Objects & Functions We generate the documentation of C++ objects and functions *from our C++ source code* by adding :ref:`Doxygen strings <developers-docs>`. -Our Doxygen C++ API documentation in classic formatting `is located here <../_static/doxyhtml/index.html>`_. +* **WarpX and ABLASTR**: `C++ Doxygen <../_static/doxyhtml/index.html>`__ + +This documentation dynamically links to objects described in dependencies: + +* **AMReX**: `C++ Doxygen <https://amrex-codes.github.io/amrex/doxygen>`__ and `Manual <https://amrex-codes.github.io/amrex/docs_html/>`__ +* **openPMD-api**: `C++ Doxygen <https://openpmd-api.readthedocs.io/en/latest/_static/doxyhtml/index.html>`__ and `Manual <https://openpmd-api.readthedocs.io>`__ +* **PICSAR-QED**: C++ Doxygen is *TODO* |