enable RTD builds for PRs

Author: 2bndy5

.github/doxygen.py

@@ -0,0 +1,32 @@
+"""WARNING -- FOR CI ONLY
+
+This script is meant to be execute in CI only.
+Running this locally will alter the Doxyfile.
+Such changes SHOULD NOT be pushed to the remote.
+"""
+
+from pathlib import Path
+
+DOCS_DIR = Path(__file__).parent.parent / "docs"
+PROPERTIES = DOCS_DIR.parent / "library.properties"
+CONFIG = DOCS_DIR / "Doxyfile"
+TMP = DOCS_DIR / "doxygenAction"
+
+
+def overwrite_doxygen_value():
+    properties = PROPERTIES.read_text(encoding="utf-8").splitlines()
+    for line in properties:
+        if line.startswith("version="):
+            _, value = line.split("=", 1)
+            version = value.strip()
+            break
+    else:
+        raise RuntimeError("version not found in library.properties")
+    config = CONFIG.read_text(encoding="utf-8")
+    TMP.write_text(f"PROJECT_NUMBER = {version}\n", encoding="utf-8")
+    config += f"\n@INCLUDE = {str(TMP)}\n"
+    CONFIG.write_text(config, encoding="utf-8")
+
+
+if __name__ == "__main__":
+    overwrite_doxygen_value()

.readthedocs.yaml

@@ -0,0 +1,32 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+build:
+  os: "ubuntu-24.04"
+  # apt_packages:
+  #   - libclang1-12
+  #   - libclang-cpp12
+  tools:
+    python: "3"
+  commands:
+    # Install doxygen from source distributions (conda forge does not keep up-to-date doxygen releases)
+    - >
+      DOXYGEN_VERSION="1.15.0" &&
+      RELEASE_TITLE=$(echo ${DOXYGEN_VERSION} | tr '.' '_') &&
+      mkdir .doxygen && cd .doxygen &&
+      curl -L "https://github.com/doxygen/doxygen/releases/download/Release_${RELEASE_TITLE}/doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz" --output doxygen.tar.gz &&
+      gunzip doxygen.tar.gz &&
+      tar xf doxygen.tar &&
+      mv doxygen-${DOXYGEN_VERSION}/bin/doxygen ./
+    # get lib version & overwrite Doxyfile values
+    - python3 .github/doxygen.py
+    # run doxygen
+    - cd docs && ../.doxygen/doxygen
+    # copy output to RTD output path for HTML files
+    - ls -R docs/html/
+    - mkdir -p ${READTHEDOCS_OUTPUT}
+    - mv docs/html/ "${READTHEDOCS_OUTPUT}"