docs: document home-manager module

Author: tomeon

nix/devshells.nix

@@ -32,21 +32,33 @@
           {
             name = "mkoptdocs";
             category = "maintenance";
-            help = "Generate NixOS module options documentation";
+            help = "Generate NixOS and Home Manager module options documentation";
             command = ''
-              docs="$(${pkgs.nix}/bin/nix "$@" build --print-out-paths --no-link "''${PRJ_ROOT}#docs")" || exit
+              install_docs() {
+                local pkgname="$1"
+                shift
 
-              seen=0
-              while read -r path; do
-                seen="$((seen + 1))"
-                if [ "$seen" -gt 1 ]; then
-                  printf 1>&2 -- 'error: more than one output path...\n'
-                  exit 1
-                fi
-                install -Dm0644 "$path" "''${PRJ_ROOT}/doc/nixos-modules.md"
-              done <<DOCS
+                local output="$1"
+                shift
+
+                docs="$(${pkgs.nix}/bin/nix "$@" build --print-out-paths --no-link "''${PRJ_ROOT}#''${pkgname}")" || exit
+
+                local path
+                local seen=0
+                while read -r path; do
+                  seen="$((seen + 1))"
+                  if [ "$seen" -gt 1 ]; then
+                    printf 1>&2 -- 'error: more than one output path...\n'
+                    exit 1
+                  fi
+                  install -Dm0644 "$path" "$output"
+                done <<DOCS
               $docs
               DOCS
+              }
+
+              install_docs nixosDocs "''${PRJ_ROOT}/doc/nixos-modules.md"
+              install_docs homeManagerDocs "''${PRJ_ROOT}/doc/home-modules.md"
             '';
           }
         ]

nix/packages.nix

@@ -9,7 +9,41 @@
     pkgs,
     system,
     ...
-  }: {
+  }: let
+    mkDocs = {
+      loc,
+      options,
+    }:
+      pkgs.nixosOptionsDoc {
+        inherit options;
+
+        # Default is currently "appendix".
+        documentType = "none";
+
+        # We only want Markdown
+        allowDocBook = false;
+        markdownByDefault = true;
+
+        # Only include our own options.
+        transformOptions = let
+          ourPrefix = "${toString self}/";
+          link = {
+            url = "/${loc}";
+            name = loc;
+          };
+        in
+          opt:
+            opt
+            // {
+              visible = opt.visible && (lib.any (lib.hasPrefix ourPrefix) opt.declarations);
+              declarations = map (decl:
+                if lib.hasPrefix ourPrefix decl
+                then link
+                else decl)
+              opt.declarations;
+            };
+      };
+  in {
     packages = {
       default = config.packages.anything-sync-daemon;
 
@@ -82,7 +116,7 @@
           };
         };
 
-      docs = let
+      nixosDocs = let
         # Use a full NixOS system rather than (say) the result of
         # `lib.evalModules`.  This is because our NixOS module refers to
         # `security.sudo`, which may itself refer to any number of other
@@ -96,38 +130,38 @@
           ];
         };
 
-        allDocs = pkgs.nixosOptionsDoc {
+        allDocs = mkDocs {
           inherit (eval) options;
+          loc = "nix/nixos-modules.nix";
+        };
+      in
+        allDocs.optionsCommonMark;
 
-          # Default is currently "appendix".
-          documentType = "none";
-
-          # We only want Markdown
-          allowDocBook = false;
-          markdownByDefault = true;
+      homeManagerDocs = let
+        # Use a full Home Manager configuration for reasons similar to those
+        # given above with respect to the NixOS module documentation.
+        eval = inputs.home-manager.lib.homeManagerConfiguration {
+          inherit pkgs;
+          modules = [
+            ({config, ...}: {
+              home.stateVersion = config.home.version.release;
+              home.username = "ignored";
+              home.homeDirectory = "/home/ignored";
+            })
+            self.homeModules.anything-sync-daemon
+          ];
+        };
 
-          # Only include our own options.
-          transformOptions = let
-            ourPrefix = "${toString self}/";
-            nixosModules = "nix/nixos-modules.nix";
-            link = {
-              url = "/${nixosModules}";
-              name = nixosModules;
-            };
-          in
-            opt:
-              opt
-              // {
-                visible = opt.visible && (lib.any (lib.hasPrefix ourPrefix) opt.declarations);
-                declarations = map (decl:
-                  if lib.hasPrefix ourPrefix decl
-                  then link
-                  else decl)
-                opt.declarations;
-              };
+        allDocs = mkDocs {
+          inherit (eval) options;
+          loc = "nix/home-modules.nix";
         };
       in
-        allDocs.optionsCommonMark;
+        allDocs.optionsCommonMark // {
+          passthru = (allDocs.OptionsCommonMark.passthru or {}) // {
+            inherit eval;
+          };
+        };
     };
   };
 }