Add Doxygen Github Action to generate docs

.github/workflows/doc-publish.yml

@@ -29,4 +29,4 @@ jobs:
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: docs
-          force_orphan: true
+          force_orphan: true

.github/workflows/doxygen-build.yml

@@ -0,0 +1,52 @@
+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: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Install python dependencies
+        run: |
+          python -m pip install --upgrade pip
+
+      - name: Install doxygen
+        run: |
+          sudo apt-get install doxygen
+          pip install coverxygen
+
+      - name: Run doxygen
+        run: doxygen Doxyfile
+
+      - name: Print Doxygen Warning Log
+        run: cat DoxygenWarningLog.txt
+
+      - 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
+
+      - 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

.github/workflows/doxygen-publish.yml

@@ -0,0 +1,34 @@
+name: Publish Doxygen Documentation
+
+on: [push, pull_request]
+
+permissions:
+  contents: write
+
+jobs:
+  build-doxygen-docs:
+    uses: ./.github/workflows/doxygen-build.yml
+
+  publish-docs:
+    runs-on: ubuntu-latest
+    needs: build-doxygen-docs
+
+    steps:
+      - name: Download doxygen documentation
+        uses: actions/download-artifact@v4
+        with:
+          name: doxygen_docs
+          path: ./doc/github_pages
+
+      - name: Unzip doxygen documentation
+        working-directory: ./doc/github_pages
+        run: |
+          unzip doxygen_docs.zip
+          rm doxygen_docs.zip
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: doc/github_pages
+          keep_files: true