docs: update nixmkdocs, use svg for logo and favicon, add module docs

docs/images/logo.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="100" height="100" fill="none"><rect width="100" height="100" fill="#222" rx="12"/><rect width="100" height="100" fill="url(#a)" rx="12"/><path fill="#3FB950" d="M18 54.7a3 3 0 0 1 4.3 0l17 17c.5.4 1 .4 1.5 0L82.5 30a3 3 0 0 1 4.2 0l2 1.9a3 3 0 0 1 0 4.2L46.2 78.7l-4 4a3 3 0 0 1-4.2 0L16 60.9a3 3 0 0 1 0-4.3l2-1.9Z"/><path fill="url(#b)" d="m89 66.6-5.3 9.6H71l6.3 11-2.7 4.8h-5.5l-9-15.8H53l9.6-9.6H89Zm-76-4.8 1 1.2 6 5.9-3.5 6-5.5-9.4 2-3.7Zm3-5 .1-.2-.1.2Zm11.4-1.1-3-3.1a6 6 0 0 0-8.5 0l-1.8 1.8H4.7L2 49.6l2.7-4.8h18l6.5-11.2H40l-12.6 22ZM62.8 18l6.4-11h5.4l2.7 4.8-9 15.7 4.4 7.9-6.9 6.9L45.8 7 56.5 7l6.2 11.1Z"/><path fill="url(#c)" d="m54.9 91.9-10.7.1-3.1-5.5a6 6 0 0 0 3.2-1.7l4-4 .2-.2L55 92Zm-19.1-7.2L31.7 92h-5.3l-2.8-4.8L29 78l6.9 6.8ZM47 78l-.8.8-4 4-.1.1.1-.1 4-4 .8-.8ZM40.2 72Zm.5-.2Zm.3-4.5-1 .9-11.7-11.7 3.3-6L41 67.3Zm54.3-22.6 2.7 4.7-2.7 4.8H77.5l-6.3 11.2h-7.6l20.8-20.7h11Zm-54.8-22 12.7.1 5.4 9.5H12l5.3-9.5h12.5l-6.2-11L26.2 7h5.5l8.8 15.8Zm44.3 3.4a6 6 0 0 0-2.4.4l1.3-2.4 1.1 2Z"/><defs><linearGradient id="b" x1="76.7" x2="59.1" y1="47.2" y2="17.1" gradientUnits="userSpaceOnUse"><stop offset=".2" stop-color="#7EB1DD"/></linearGradient><linearGradient id="c" x1="63.4" x2="81.3" y1="70.3" y2="40.6" gradientUnits="userSpaceOnUse"><stop offset="1" stop-color="#5277C3"/></linearGradient><radialGradient id="a" cx="0" cy="0" r="1" gradientTransform="matrix(0 50 -50 0 50 50)" gradientUnits="userSpaceOnUse"><stop offset=".5" stop-color="#091A3D"/><stop offset="1" stop-color="#000819"/></radialGradient></defs></svg>

docs/options.md

@@ -0,0 +1,3 @@
+# Options
+
+{% include 'options.md' %}

docs/style.css

@@ -0,0 +1,15 @@
+.md-header__button.md-logo {
+  margin: 0;
+  padding-top: .2rem;
+  padding-bottom: .2rem;
+}
+
+[dir="ltr"] .md-header__title {
+  margin-left: 0;
+}
+
+.md-header__button.md-logo img,
+.md-header__button.md-logo svg {
+  height: 2rem;
+}
+

flake.lock

@@ -169,21 +169,6 @@
         "type": "github"
       }
     },
-    "mkdocs-material-umami": {
-      "locked": {
-        "lastModified": 1745840856,
-        "narHash": "sha256-1Ad1JTMQMP6YsoIKAA+SBCE15qWrYkGue9/lXOLnu9I=",
-        "owner": "technofab",
-        "repo": "mkdocs-material-umami",
-        "rev": "3ac9b194450f6b779c37b8d16fec640198e5cd0a",
-        "type": "gitlab"
-      },
-      "original": {
-        "owner": "technofab",
-        "repo": "mkdocs-material-umami",
-        "type": "gitlab"
-      }
-    },
     "nix": {
       "inputs": {
         "flake-compat": [
@@ -255,11 +240,11 @@
     "nix-mkdocs": {
       "locked": {
         "dir": "lib",
-        "lastModified": 1745841841,
+        "lastModified": 1757055638,
-        "narHash": "sha256-297zPQbUlc7ZAYDoaD6mCmQxCC3Tr4YOKekRF1ArZ7g=",
+        "narHash": "sha256-KHYSkEreFe4meXzSdEbknC/HwaQSNClQkc8vzHlAsMM=",
         "owner": "technofab",
         "repo": "nixmkdocs",
-        "rev": "c7e3c3b13ded25818e9789938387bba6f2cde690",
+        "rev": "7840a5febdbeaf2da90babf6c94b3d0929d2bf74",
         "type": "gitlab"
       },
       "original": {
@@ -368,7 +353,6 @@
       "inputs": {
         "devenv": "devenv",
         "flake-parts": "flake-parts_2",
-        "mkdocs-material-umami": "mkdocs-material-umami",
         "nix-devtools": "nix-devtools",
         "nix-gitlab-ci": "nix-gitlab-ci",
         "nix-mkdocs": "nix-mkdocs",

flake.nix

@@ -17,6 +17,7 @@
       perSystem = {
         lib,
         pkgs,
+        self',
         config,
         ...
       }: {
@@ -65,81 +66,48 @@
           };
         };
 
-        doc = {
+        docs."default".config = {
           path = ./docs;
-          deps = pp: [
+          material = {
-            pp.mkdocs-material
+            enable = true;
-            (pp.callPackage inputs.mkdocs-material-umami {})
+            colors = {
-          ];
+              primary = "green";
+              accent = "light green";
+            };
+            umami = {
+              enable = true;
+              src = "https://analytics.tf/umami";
+              siteId = "716d1869-9342-4b62-a770-e15d2d5c807d";
+              domains = ["nixtest.projects.tf"];
+            };
+          };
+          macros = {
+            enable = true;
+            includeDir = toString self'.packages.optionsDocs;
+          };
           config = {
             site_name = "Nixtest";
+            site_url = "https://nixtest.projects.tf";
             repo_name = "TECHNOFAB/nixtest";
             repo_url = "https://gitlab.com/TECHNOFAB/nixtest";
-            edit_uri = "edit/main/docs/";
+            extra_css = ["style.css"];
             theme = {
-              name = "material";
-              features = ["content.code.copy" "content.action.edit"];
               icon.repo = "simple/gitlab";
-              logo = "images/logo.png";
+              logo = "images/logo.svg";
-              favicon = "images/favicon.png";
+              favicon = "images/logo.svg";
-              palette = [
-                {
-                  scheme = "default";
-                  media = "(prefers-color-scheme: light)";
-                  primary = "green";
-                  accent = "light green";
-                  toggle = {
-                    icon = "material/brightness-7";
-                    name = "Switch to dark mode";
-                  };
-                }
-                {
-                  scheme = "slate";
-                  media = "(prefers-color-scheme: dark)";
-                  primary = "green";
-                  accent = "light green";
-                  toggle = {
-                    icon = "material/brightness-4";
-                    name = "Switch to light mode";
-                  };
-                }
-              ];
             };
-            plugins = ["search" "material-umami"];
             nav = [
               {"Introduction" = "index.md";}
               {"Usage" = "usage.md";}
               {"Reference" = "reference.md";}
               {"CLI" = "cli.md";}
               {"Example Configs" = "examples.md";}
+              {"Options" = "options.md";}
             ];
             markdown_extensions = [
               "pymdownx.superfences"
               "admonition"
             ];
-            extra.analytics = {
-              provider = "umami";
-              site_id = "716d1869-9342-4b62-a770-e15d2d5c807d";
-              src = "https://analytics.tf/umami";
-              domains = "nixtest.projects.tf";
-              feedback = {
-                title = "Was this page helpful?";
-                ratings = [
-                  {
-                    icon = "material/thumb-up-outline";
-                    name = "This page is helpful";
-                    data = "good";
-                    note = "Thanks for your feedback!";
-                  }
-                  {
-                    icon = "material/thumb-down-outline";
-                    name = "This page could be improved";
-                    data = "bad";
-                    note = "Thanks for your feedback! Please leave feedback by creating an issue :)";
-                  }
-                ];
-              };
-            };
           };
         };
 
@@ -212,7 +180,8 @@
 
         packages = let
           ntlib = import ./lib {inherit pkgs lib;};
-        in {
+          doclib = inputs.nix-mkdocs.lib {inherit lib pkgs;};
+        in rec {
           default = pkgs.callPackage ./package.nix {};
           tests = ntlib.mkNixtest {
             modules = ntlib.autodiscover {dir = ./tests;};
@@ -220,6 +189,24 @@
               inherit pkgs ntlib;
             };
           };
+          optionsDoc = doclib.mkOptionDocs {
+            module = {
+              _module.args.pkgs = pkgs;
+              imports = [
+                ntlib.module
+              ];
+            };
+            roots = [
+              {
+                url = "https://gitlab.com/TECHNOFAB/nixtest/-/blob/main/lib";
+                path = toString ./lib;
+              }
+            ];
+          };
+          optionsDocs = pkgs.runCommand "options-docs" {} ''
+            mkdir -p $out
+            ln -s ${optionsDoc} $out/options.md
+          '';
         };
       };
     };
@@ -235,7 +222,6 @@
     nix-gitlab-ci.url = "gitlab:technofab/nix-gitlab-ci/2.0.1?dir=lib";
     nix-devtools.url = "gitlab:technofab/nix-devtools?dir=lib";
     nix-mkdocs.url = "gitlab:technofab/nixmkdocs?dir=lib";
-    mkdocs-material-umami.url = "gitlab:technofab/mkdocs-material-umami";
   };
 
   nixConfig = {

lib/module.nix

@@ -13,6 +13,7 @@
     removePrefix
     assertMsg
     generators
+    literalExpression
     ;
 
   nixtest-lib = import ./default.nix {inherit pkgs lib;};
@@ -27,6 +28,18 @@
     _type = "unset";
   };
   isUnset = isType "unset";
+  unsetOr = typ:
+    (types.either unsetType typ)
+    // {
+      inherit (typ) description getSubOptions;
+    };
+  mkUnsetOption = opts:
+    mkOption (opts
+      // {
+        type = unsetOr opts.type;
+        default = opts.default or unset;
+        defaultText = literalExpression "unset";
+      });
 
   filterUnset = value:
     if builtins.isAttrs value && !builtins.hasAttr "_type" value
@@ -45,8 +58,11 @@
     ...
   }: {
     options = {
-      pos = mkOption {
+      pos = mkUnsetOption {
-        type = types.either types.attrs unsetType;
+        type = types.attrs;
+        description = ''
+          Position of test, use `__curPos` for automatic insertion of current position.
+        '';
         default = pos;
         apply = val:
           if isUnset val
@@ -57,6 +73,9 @@
       };
       type = mkOption {
         type = types.enum ["unit" "snapshot" "script"];
+        description = ''
+          Type of test, has to be one of "unit", "snapshot" or "script".
+        '';
         default = "unit";
         apply = value:
           assert assertMsg (value != "script" || !isUnset config.script)
@@ -76,43 +95,66 @@
       };
       name = mkOption {
         type = types.str;
+        description = ''
+          Name of this test.
+        '';
       };
-      description = mkOption {
+      description = mkUnsetOption {
-        type = types.either types.str unsetType;
+        type = types.str;
-        default = unset;
+        description = ''
+          Short description of the test.
+        '';
       };
       format = mkOption {
         type = types.enum ["json" "pretty"];
+        description = ''
+          Which format to use for serializing arbitrary values.
+          Required since this config is serialized to JSON for passing it to Nixtest, so no Nix-values can be used directly.
+
+          - `json`: serializes the data to json using `builtins.toJSON`
+          - `pretty`: serializes the data to a "pretty" format using `lib.generators.toPretty`
+        '';
         default = "json";
       };
-      expected = mkOption {
+      expected = mkUnsetOption {
         type = types.anything;
-        default = unset;
+        description = ''
+          Expected value of the test. Remember, the values are serialized (see [here](#suitesnametestsformat)).
+        '';
         apply = val:
           if isUnset val || config.format == "json"
           then val
           else generators.toPretty {} val;
       };
-      actual = mkOption {
+      actual = mkUnsetOption {
         type = types.anything;
-        default = unset;
+        description = ''
+          Actual value of the test. Remember, the values are serialized (see [here](#suitesnametestsformat)).
+        '';
         apply = val:
           if isUnset val || config.format == "json"
           then val
           else generators.toPretty {} val;
       };
-      actualDrv = mkOption {
+      actualDrv = mkUnsetOption {
-        type = types.either types.package unsetType;
+        type = types.package;
-        default = unset;
+        description = ''
+          Actual value of the test, but as a derivation.
+          Nixtest will build this derivation when running the test, then compare the contents of the
+          resulting file to the [`expected`](#suitesnametestsexpected) value.
+        '';
         apply = val:
         # keep unset value
           if isUnset val
           then val
           else builtins.unsafeDiscardStringContext (val.drvPath or "");
       };
-      script = mkOption {
+      script = mkUnsetOption {
-        type = types.either types.str unsetType;
+        type = types.str;
-        default = unset;
+        description = ''
+          Script to run for the test.
+          Nixtest will run this, failing the test if it exits with a non-zero exit code.
+        '';
         apply = val:
           if isUnset val
           then val
@@ -132,11 +174,19 @@
     options = {
       name = mkOption {
         type = types.str;
+        description = ''
+          Name of the suite, uses attrset name by default.
+        '';
         default = name;
+        defaultText = literalExpression name;
       };
-      pos = mkOption {
+      pos = mkUnsetOption {
-        type = types.either types.attrs unsetType;
+        type = types.attrs;
-        default = unset;
+        description = ''
+          Position for tests, use `__curPos` for automatic insertion of current position.
+          This will set `pos` for every test of this suite, useful if the suite's tests are all in a single file.
+        '';
+        example = literalExpression "__curPos";
       };
       tests = mkOption {
         type = types.listOf (types.submoduleWith {
@@ -146,6 +196,9 @@
             inherit testsBase;
           };
         });
+        description = ''
+          Define tests of this suite here.
+        '';
         default = [];
       };
     };
@@ -154,12 +207,18 @@
   nixtestSubmodule = {config, ...}: {
     options = {
       base = mkOption {
-        description = "Base directory of the tests, will be removed from the test file path";
         type = types.str;
+        description = ''
+          Base directory of the tests, will be removed from the test file path.
+          This makes it possible to show the relative path from the git repo, instead of ugly Nix store paths.
+        '';
         default = "";
       };
       skip = mkOption {
         type = types.str;
+        description = ''
+          Tests to skip, is passed to Nixtest's `--skip` param.
+        '';
         default = "";
       };
       suites = mkOption {
@@ -169,12 +228,22 @@
             testsBase = config.base;
           };
         });
+        description = ''
+          Define your test suites here, every test belongs to a suite.
+        '';
         default = {};
         apply = suites:
           map (
             n: filterUnset (builtins.removeAttrs suites.${n} ["pos"])
           )
           (builtins.attrNames suites);
+        example = {
+          "Suite A".tests = [
+            {
+              name = "Some Test";
+            }
+          ];
+        };
       };
 
       finalConfigJson = mkOption {