Merge pull request #32 from tmayoff/docs

.github/workflows/deploy_docs.yml

@@ -5,29 +5,37 @@ on:
       - main
     paths:
       - docs/**
-      - mkdocs.yml
+      - Doxyfile
   workflow_dispatch:
 
 permissions:
   contents: write
 jobs:
   deploy_docs:
     runs-on: ubuntu-latest
+
+    permissions:
+      pages: write      # to deploy to Pages
+      id-token: write   # to verify the deployment originates from an appropriate source
+
     steps:
       - uses: actions/checkout@v4
+
+      - uses: DeterminateSystems/nix-installer-action@v14
+      - uses: DeterminateSystems/magic-nix-cache-action@v8
+
       - name: Configure Git Credentials
         run: |
           git config user.name github-actions[bot]
           git config user.email 41898282+github-actions[bot]@users.noreply.github.com
-      - uses: actions/setup-python@v5
-        with:
-          python-version: 3.x
-      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
-      - uses: actions/cache@v4
+      - name: build docs
+        run: |
+          mkdir -p build/docs
+          nix develop --command just build_docs
+      - name: upload artifacts
+        uses: actions/upload-pages-artifact@v3
         with:
-          key: mkdocs-material-${{ env.cache_id }}
-          path: .cache
-          restore-keys: |
-            mkdocs-material-
-      - run: pip install mkdocs-material mkdocs-mermaid2-plugin
-      - run: mkdocs gh-deploy --force
+          path: 'build/docs/html'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

flake.nix

@@ -30,9 +30,6 @@
           meson
           cmake
           ninja
-
-          # doxygen
-          # graphviz
         ];
 
         rawBuildInputs = with pkgs; [
@@ -93,8 +90,8 @@
 
               renderdoc
 
-              tracy-x11 # for the profiler
-              wayland
+              doxygen
+              graphviz
             ]
             ++ rawNativeBuildInputs;