gh(docs): generate doxygen docs on push to trunk

.editorconfig

@@ -9,3 +9,6 @@ charset = utf-8
 [*.{nix,yaml,yml}]
 indent_style = spaces
 indent_width = 2
+
+[Doxyfile]
+indent_style = spaces

.github/workflows/generate_docs.yml

@@ -0,0 +1,27 @@
+name: 'Generate docs'
+on:
+  push:
+    branches:
+      - 'trunk'
+    paths: 
+      - '**.cpp'
+      - '**.hpp'
+      - '**.md'
+
+jobs:
+  generate:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Checkout doxygen-awesome
+        uses: textbook/git-checkout-submodule-action@master
+      - name: Doxygen Action
+        uses: mattnotmitt/doxygen-action@v1.9.8
+        with:
+          doxyfile-path: "./Doxyfile"
+          working-directory: "."
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./generated-docs/html

.gitignore

@@ -13,6 +13,8 @@
 
 !CMakeLists.txt
 
+!Doxyfile
+
 !meson.build
 !meson_options.txt
 

flake.nix

@@ -46,6 +46,9 @@
           ++ pkgs.callPackage ./nix/dependencies.nix {inherit pkgs;};
 
         nativeDeps = [
+          pkgs.doxygen
+          pkgs.graphviz
+
           pkgs.meson
           pkgs.cmake
           pkgs.ninja

nix/package/package.nix

@@ -5,7 +5,6 @@
   buildDeps,
   rootDir,
 }: let
-
   direBase = pkgs.stdenv.mkDerivation {
     pname = "dire";
     version = "0.1.0";

nix/shell.nix

@@ -4,44 +4,44 @@
   buildDeps,
   pre-commit-check,
   ...
-}:
+}: let
+  baseShellAttrs = {
+    hardeningDisable = ["all"];
 
-let baseShellAttrs = { 
-	hardeningDisable = ["all"];
+    packages = nativeDeps ++ [pkgs.just];
 
-	packages = nativeDeps ++ [ pkgs.just ];
+    buildInputs = buildDeps;
+  };
 
-	buildInputs = buildDeps;
-}; 
+  gccStdenv = pkgs.gcc11Stdenv;
 
-gccStdenv = pkgs.gcc11Stdenv;
+  clangStdenv = pkgs.llvmPackages_16.stdenv;
 
-clangStdenv = pkgs.llvmPackages_16.stdenv;
+  ciGcc = pkgs.mkShell.override {stdenv = gccStdenv;} baseShellAttrs;
 
-ciGcc = pkgs.mkShell.override { stdenv = gccStdenv;  } baseShellAttrs;
+  ciClang = pkgs.mkShell.override {stdenv = clangStdenv;} baseShellAttrs;
 
-ciClang = pkgs.mkShell.override { stdenv = clangStdenv;  } baseShellAttrs;
+  devPackages = [
+    pkgs.act
+  ];
 
-devPackages = [
-	pkgs.act
-];
+  baseDevShellAttrs =
+    baseShellAttrs
+    // {
+      inherit (pre-commit-check) shellHook;
 
-baseDevShellAttrs = (baseShellAttrs // {
-		inherit (pre-commit-check) shellHook;
+      packages = baseShellAttrs.packages ++ devPackages;
+    };
 
-		packages = baseShellAttrs.packages ++ devPackages;
-});
+  devClang = pkgs.mkShell.override {stdenv = clangStdenv;} (baseDevShellAttrs
+    // {
+      env = {
+        CLANGD_PATH = "${pkgs.clang-tools_16}/bin/clangd";
+        ASAN_SYMBOLIZER_PATH = "${pkgs.llvmPackages_16.bintools-unwrapped}/bin/llvm-symbolizer";
+      };
+    });
 
-devClang = pkgs.mkShell.override { stdenv = clangStdenv;  } (baseDevShellAttrs // {
-	env = {
-		CLANGD_PATH = "${pkgs.clang-tools_16}/bin/clangd";
-		ASAN_SYMBOLIZER_PATH = "${pkgs.llvmPackages_16.bintools-unwrapped}/bin/llvm-symbolizer";
-	};
-});
-
-devGcc = pkgs.mkShell.override { stdenv = gccStdenv;  } baseDevShellAttrs;
-
-in 
-{
-	inherit ciGcc ciClang devGcc devClang;
+  devGcc = pkgs.mkShell.override {stdenv = gccStdenv;} baseDevShellAttrs;
+in {
+  inherit ciGcc ciClang devGcc devClang;
 }