Prep for readthedocs integration

.readthedocs.yaml

@@ -0,0 +1,22 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+# Build documentation in the "doc/" directory with Sphinx
+sphinx:
+  configuration: doc/conf.py
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+    install:
+    - requirements: doc/requirements.txt

BUILDING.md → BuildDocs.md

@@ -9,5 +9,3 @@ make -j
 doxygen ../Doxyfile.in
 DOC_BUILD_DIR=$PWD sphinx-build -c ../doc/ -b html -Dbreathe_projects.GRGL=$PWD/doc/xml ../doc/ $PWD/doc/sphinx/
 ```
-
-When publishing publically we'll need to download `pygrgl` from `pypi` to let this work without building the C++ code.

Doxyfile.in

@@ -32,7 +32,7 @@ DOXYFILE_ENCODING      = UTF-8
 # title of most generated pages and in a few other places.
 # The default value is: My Project.
 
-PROJECT_NAME           = "GRGL"
+PROJECT_NAME           = "grgl"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
 # could be handy for archiving the generated documentation or if some version

doc/conf.py

@@ -24,9 +24,9 @@
 
 # Breathe configuration
 breathe_projects = {
-    "GRGL": DOC_OUTPUT + "/xml/",
+    "grgl": DOC_OUTPUT + "/xml/",
 }
-breathe_default_project = "GRGL"
+breathe_default_project = "grgl"
 
 
 autosummary_generate = True  # Turn on sphinx.ext.autosummary