Add Doxygen Github Action to generate docs

.github/workflows/Doc-coverage.yml

@@ -0,0 +1,45 @@
+name: Build Documentation Coverage
+
+on: [push, pull_request]
+
+permissions:
+  contents: write
+
+jobs:
+  build-doxygen-docs:
+    uses: ./.github/workflows/doxygen-build.yml
+
+  doxygen-docs:
+    runs-on: ubuntu-latest
+    needs: build-doxygen-docs
+    defaults:
+      run:
+        working-directory: ./doc
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Install python dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install coverxygen
+
+      - name: Restore Doxygen Output Cache
+        uses: actions/cache@v3
+        id: doxygen-output-cache
+        with:
+          path: |
+            doxygenOut/html
+            doxygenOut/xml
+          key: ${{ github.ref }}-doxygen-output
+
+      - name: Run coverxygen
+        run: python3 -m coverxygen --format summary --xml-dir doxygenOut/xml/ --src-dir .. --output doc-coverage.info
+
+      - name: Print doc coverage
+        run: cat doc-coverage.info

.github/workflows/doc-publish.yml

@@ -1,17 +1,13 @@
 name: Publish Documentation
 
-on:
-  push:
-    branches:
-      - main
+on: [push, pull_request]
 
 permissions:
   contents: write
 
 jobs:
   build-docs:
     uses: ./.github/workflows/doc-build.yml
-
   publish-docs:
     runs-on: ubuntu-latest
     needs: build-docs
@@ -29,4 +25,5 @@ jobs:
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: docs
-          force_orphan: true
+          destination_dir: docs/sphinx
+          keep_files: true

.github/workflows/doxygen-build.yml

@@ -0,0 +1,44 @@
+name: Build and Deploy Doxygen Documentation
+
+on: [workflow_call, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    defaults:
+      run:
+        working-directory: ./doc
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install Doxygen
+        run: |
+          sudo apt-get install -y doxygen
+          which doxygen
+
+      - name: Run doxygen
+        run: doxygen Doxyfile
+
+      - name: Cache Doxygen Output
+        uses: actions/cache@v3
+        id: cache-doxygen
+        with:
+          path: doxygenOut/xml
+          key: ${{ github.ref }}-doxygen-output
+
+      - name: Print Doxygen Warning Log
+        run: cat DoxygenWarningLog.txt
+
+      - name: Zip doxygen documentation
+        run: |
+          mv doxygenOut/html doxygen_docs
+          zip -r doxygen_docs.zip doxygen_docs
+
+      - name: Upload doxygen_docs
+        uses: actions/upload-artifact@v4
+        with:
+          name: doxygen_docs
+          path: ./doc/doxygen_docs.zip