aboutsummaryrefslogtreecommitdiff
path: root/Docs/source/conf.py
diff options
context:
space:
mode:
authorGravatar Axel Huebl <axel.huebl@plasma.ninja> 2022-05-11 11:48:49 -0700
committerGravatar GitHub <noreply@github.com> 2022-05-11 11:48:49 -0700
commite836ce9cfd40432bff46fe9c58b3e8c2d2f9f284 (patch)
treebdc8ada77a07302f10efb8bc8a0b992c55e8bc32 /Docs/source/conf.py
parentcfd9249ae17ef8450aa5dd0327793b7f6e720501 (diff)
downloadWarpX-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/conf.py')
-rw-r--r--Docs/source/conf.py4
1 files changed, 3 insertions, 1 deletions
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;'