diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | Docs/Doxyfile | 3 | ||||
| -rw-r--r-- | Docs/source/conf.py | 4 | ||||
| -rw-r--r-- | Docs/source/developers/doxygen.rst | 8 |
4 files changed, 13 insertions, 3 deletions
diff --git a/.gitignore b/.gitignore index b58f6be4e..5332afb54 100644 --- a/.gitignore +++ b/.gitignore @@ -35,6 +35,7 @@ pywarpx.egg-info/ ########## Docs/amrex-doxygen-web.tag.xml Docs/warpx-doxygen-web.tag.xml +Docs/openpmd-api-doxygen-web.tag.xml Docs/doxyhtml/ Docs/doxyxml/ Docs/source/_static/ diff --git a/Docs/Doxyfile b/Docs/Doxyfile index c383991ad..4d20673fd 100644 --- a/Docs/Doxyfile +++ b/Docs/Doxyfile @@ -2104,7 +2104,8 @@ SKIP_FUNCTION_MACROS = YES # the path). If a tag file is not located in the directory in which doxygen is # run, you must also specify the path to the tagfile here. -TAGFILES = amrex-doxygen-web.tag.xml=https://amrex-codes.github.io/amrex/doxygen/ +TAGFILES = amrex-doxygen-web.tag.xml=https://amrex-codes.github.io/amrex/doxygen/ \ + openpmd-api-doxygen-web.tag.xml=https://openpmd-api.readthedocs.io/en/latest/_static/doxyhtml/ # When a file name is specified after GENERATE_TAGFILE, doxygen will create a # tag file that is based on the input files it reads. See section "Linking to diff --git a/Docs/source/conf.py b/Docs/source/conf.py index 1eaa61fe4..c61b2c476 100644 --- a/Docs/source/conf.py +++ b/Docs/source/conf.py @@ -188,10 +188,12 @@ primary_domain = 'cpp' # Tell sphinx what the pygments highlight language should be. highlight_language = 'cpp' -# Download AMReX Doxygen Tagfile to interlink Doxygen docs +# Download AMReX & openPMD-api Doxygen Tagfile to interlink Doxygen docs url = 'https://amrex-codes.github.io/amrex/docs_xml/doxygen/amrex-doxygen-web.tag.xml' urllib.request.urlretrieve(url, '../amrex-doxygen-web.tag.xml') +url = 'https://openpmd-api.readthedocs.io/en/latest/_static/doxyhtml/openpmd-api-doxygen-web.tag.xml' +urllib.request.urlretrieve(url, '../openpmd-api-doxygen-web.tag.xml') # Build Doxygen subprocess.call('cd ../; doxygen;' 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* |