Adding docs

.github/workflows/static.yml

@@ -4,7 +4,7 @@ name: Deploy static content to Pages
 on:
   # Runs on pushes targeting the default branch
   push:
-    branches: ["master"]
+    branches: [ "master", "feature/docs" ]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:

docs/flake-module.nix

@@ -1,18 +1,18 @@
-{self, ...}: {
+{ self, ... }: {
   perSystem = { config, self', inputs', pkgs, system, ... }: {
     packages.docs = pkgs.buildNpmPackage {
       pname = "docs";
       version = "0.1.0";
 
-      src = 
+      src =
         pkgs.nix-gitignore.gitignoreSource [
           ".vscode"
           "README.md"
           ".gitignore"
           "nix"
           "flake.*"
         ]
-        ./.;
+          ./.;
 
       buildInputs = [
         pkgs.vips

nix/pre-commit/flake-module.nix

@@ -16,7 +16,8 @@
           # lint shell scripts
           shellcheck.enable = true;
           # nix format
-          nixpkgs-fmt.enable = true;
+          # TODO: need to preformat things accordingly and potentially use another formatter
+          # nixpkgs-fmt.enable = true;
         };
       };
     };

run_tests.sh

@@ -115,6 +115,18 @@ nix build -L "${NIX_OPTIONS[@]}" "${NIX_TESTS_OPTIONS[@]}" -f ./tests.nix || {
     exit 5
 }
 
+echo -e "\e[1m=== Building .#docs (= Generating GitHub Page resources)\e[0m" >&2
+rm -rf target/nix-result*
+nix build -L "${NIX_OPTIONS[@]}" "${NIX_TESTS_OPTIONS[@]}" .#docs || {
+    echo "==================" >&2
+    echo "cd $top" >&2
+    echo "nix build -L \\" >&2
+    echo "  ${NIX_OPTIONS[*]} ${NIX_TESTS_OPTIONS[*]} \\" >&2
+    echo "   .#docs"
+    echo "=> FAILED" >&2
+    exit 5
+}
+
 echo -e "\e[1m=== Checking for uncomitted changes\e[0m" >&2
 if test -n "$(git status --porcelain)"; then
     echo ""