Merge remote-tracking branch 'upstream/master' into yuv444

.github/workflows/CI.yml

@@ -992,7 +992,6 @@ jobs:
           pacman -U --noconfirm mingw-w64-ucrt-x86_64-curl-8.8.0-1-any.pkg.tar.zst
           pacman -Syu --noconfirm \
             --ignore=mingw-w64-ucrt-x86_64-curl \
-            doxygen \
             git \
             mingw-w64-ucrt-x86_64-boost \
             mingw-w64-ucrt-x86_64-cmake \
@@ -1007,6 +1006,31 @@ jobs:
             mingw-w64-ucrt-x86_64-opus \
             mingw-w64-ucrt-x86_64-toolchain
 
+      - name: Install Doxygen
+        # GCC compiled doxygen has issues when running graphviz
+        env:
+          DOXYGEN_VERSION: "1.11.0"
+        run: |
+          # Set version variables
+          $doxy_ver = $env:DOXYGEN_VERSION
+          $_doxy_ver = $doxy_ver.Replace(".", "_")
+
+          # Download the Doxygen installer
+          Invoke-WebRequest -Uri `
+            "https://github.com/doxygen/doxygen/releases/download/Release_${_doxy_ver}/doxygen-${doxy_ver}-setup.exe" `
+            -OutFile "doxygen-setup.exe"
+
+          # Run the installer
+          Start-Process `
+            -FilePath .\doxygen-setup.exe `
+            -ArgumentList `
+              '/VERYSILENT' `
+          -Wait `
+          -NoNewWindow
+
+          # Clean up
+          Remove-Item -Path doxygen-setup.exe
+
       - name: Setup python
         # use this instead of msys2 python due to known issues using wheels, https://www.msys2.org/docs/python/
         id: setup-python

.gitmodules

@@ -10,6 +10,10 @@
 	path = third-party/build-deps
 	url = https://github.com/LizardByte/build-deps.git
 	branch = dist
+[submodule "third-party/doxygen-awesome-css"]
+	path = third-party/doxygen-awesome-css
+	url = https://github.com/jothepro/doxygen-awesome-css.git
+	branch = main
 [submodule "third-party/googletest"]
 	path = third-party/googletest
 	url = https://github.com/google/googletest/

.readthedocs.yaml

@@ -10,16 +10,20 @@ version: 2
 build:
   os: ubuntu-24.04
   tools:
-    python: "3.11"
+    python: "miniconda-latest"
   apt_packages:
-    - graphviz  # required to build diagrams
     - libboost-locale-dev  # required for rstcheck in cpp code block
   jobs:
     post_build:
       - find ./third-party -iname "*.rst" -type f -delete  # find and delete rst files in third-party
       - rstcheck -r .  # lint rst files
       # - rstfmt --check --diff -w 120 .  # check rst formatting
 
+# using conda, we can get newer doxygen and graphviz than ubuntu provide
+# https://github.com/readthedocs/readthedocs.org/issues/8151#issuecomment-890359661
+conda:
+  environment: docs/environment.yml
+
 # submodules required for include statements
 submodules:
   include: all

docs/CMakeLists.txt

@@ -120,7 +120,7 @@ list(APPEND SPHINX_BUILD_EPUB_COMMAND
 add_custom_target(docs ALL
         WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
         COMMENT "Building documentation"
-        COMMAND ${SPHINX_BUILD_HTML_COMMAND}
-        COMMAND ${SPHINX_BUILD_EPUB_COMMAND}
+        COMMAND ${CMAKE_COMMAND} -E env DOXY_PATH=$<TARGET_FILE:Doxygen::doxygen> ${SPHINX_BUILD_HTML_COMMAND}
+        COMMAND ${CMAKE_COMMAND} -E env DOXY_PATH=$<TARGET_FILE:Doxygen::doxygen> ${SPHINX_BUILD_EPUB_COMMAND}
         VERBATIM
 )