RTD: Doxygen 1.9.1 to latest

.readthedocs.yml

@@ -9,14 +9,17 @@ version: 2
 build:
  os: ubuntu-22.04
  tools:
- python: "3.11"
+ python: "mambaforge-latest"
+ # python: "3.11"
 
 sphinx:
-  configuration: Docs/source/conf.py
+ configuration: Docs/source/conf.py
 
-python:
- install:
- - requirements: Docs/requirements.txt
+conda:
+ environment: Docs/conda.yml
+# python:
+# install:
+# - requirements: Docs/requirements.txt
 
 formats:
  - htmlzip

Docs/README.md

@@ -9,12 +9,13 @@ More information can be found in Docs/source/developers/documentation.rst.
 
 Install the Python requirements for compiling the documentation:
 ```
-python3 -m pip install -r Docs/requirements.txt
+cd Docs/
+python3 -m pip install -r requirements.txt
 ```
 
 ### Compiling the documentation
 
-`cd` into the `Docs/` directory and type
+Still in the `Docs/` directory, type
 ```
 make html
 ```

Docs/conda.yml

@@ -0,0 +1,12 @@
+name: readthedocs
+
+channels:
+ - conda-forge
+ - nodefaults
+
+dependencies:
+ - python
+ - doxygen
+ - pip
+ - pip:
+ - -r requirements.txt

Docs/requirements.txt

@@ -5,7 +5,7 @@
 # License: BSD-3-Clause-LBNL
 
 # WarpX PICMI bindings w/o C++ component (used for autoclass docs)
--e Python
+-e ../Python
 breathe
 docutils>=0.17.1
 

Docs/source/developers/documentation.rst

@@ -56,16 +56,15 @@ First, make sure you are in the root directory of WarpX's source and install the
 
 .. code-block:: sh
 
- python3 -m pip install -r Docs/requirements.txt
+ cd Docs/
+ python3 -m pip install -r requirements.txt
 
 You will also need Doxygen (macOS: ``brew install doxygen``; Ubuntu: ``sudo apt install doxygen``).
 
-Then, to compile the documentation, use
+Still in the ``Docs/`` directory, compile the documentation via
 
 .. 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 and breathe.