remove sphinx and update RTD config (#235)

Author: 2bndy5

.github/doxygen.py

@@ -0,0 +1,25 @@
+"""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
+import json
+
+DOCS_DIR = Path(__file__).parent.parent / "docs"
+PROPERTIES = DOCS_DIR.parent / "library.json"
+CONFIG = DOCS_DIR / "Doxyfile"
+TMP = DOCS_DIR / "doxygenAction"
+
+
+def overwrite_doxygen_value():
+    properties = json.loads(PROPERTIES.read_text(encoding="utf-8"))
+    assert "version" in properties
+    config = CONFIG.read_text(encoding="utf-8")
+    TMP.write_text("PROJECT_NUMBER = {}\n".format(properties["version"]), 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

@@ -6,20 +6,28 @@
 version: 2
 
 build:
-  os: "ubuntu-20.04"
+  os: "ubuntu-22.04"
+  apt_packages:
+    - libclang1-12
+    - libclang-cpp12
   tools:
     python: "3"
-
-# Build documentation in the docs/ directory with Sphinx
-sphinx:
-  configuration: docs/sphinx/conf.py
-
-# Optionally build your docs in additional formats such as PDF
-#formats:
-#  - pdf
-# latex builds break for sphinx-immaterial theme
-
-# install Python requirements required to build docs
-python:
-  install:
-    - requirements: docs/sphinx/requirements.txt
+  commands:
+    # Install doxygen from source distributions (conda forge does not keep up-to-date doxygen releases)
+    - >
+      DOXYGEN_VERSION="1.12.0" &&
+      mkdir .doxygen && cd .doxygen &&
+      echo $(pwd) &&
+      echo "https://sourceforge.net/projects/doxygen/files/rel-$DOXYGEN_VERSION/doxygen-$DOXYGEN_VERSION.linux.bin.tar.gz" &&
+      curl -L https://sourceforge.net/projects/doxygen/files/rel-$DOXYGEN_VERSION/doxygen-$DOXYGEN_VERSION.linux.bin.tar.gz > 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}"

docs/Doxyfile

@@ -17,7 +17,7 @@
 # Project related configuration options
 #---------------------------------------------------------------------------
 
-PROJECT_ICON = sphinx/_static/new_favicon.ico
+PROJECT_ICON = images/favicon.ico
 
 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
 # double-quotes, unless you are using Doxywizard) that should identify the
@@ -286,40 +286,6 @@ MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
 
 GENERATE_LATEX         = NO
 
-#---------------------------------------------------------------------------
-# Configuration options related to the XML output
-#---------------------------------------------------------------------------
-
-# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
-# captures the structure of the code including all documentation.
-# The default value is: NO.
-
-GENERATE_XML           = YES
-
-# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
-# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
-# it.
-# The default directory is: xml.
-# This tag requires that the tag GENERATE_XML is set to YES.
-
-XML_OUTPUT             = sphinx/xml
-
-# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
-# listings (including syntax highlighting and cross-referencing information) to
-# the XML output. Note that enabling this will significantly increase the size
-# of the XML output.
-# The default value is: YES.
-# This tag requires that the tag GENERATE_XML is set to YES.
-
-XML_PROGRAMLISTING     = NO
-
-# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
-# namespace members in file scope as well, matching the HTML output.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_XML is set to YES.
-
-XML_NS_MEMB_FILE_SCOPE = NO
-
 #---------------------------------------------------------------------------
 # Configuration options related to the preprocessor
 #---------------------------------------------------------------------------