Docs for modular modules

Author: Zh40Le1ZOOB

docs/api.md

@@ -14,12 +14,16 @@ import { RenderDocs } from "easy-nix-documentation";
 
 ## Main API
 
-<RenderDocs :options="data" :exclude="[/^_module\.args$/, /^build\.*/, /programs/]"  />
+<RenderDocs :options="data" :exclude="[/^_module\.args$/, /^build\.*/, /programs/, /^\<imports = \[ .* \]\>/]"  />
 
 ## Program configuration
 
 <RenderDocs :options="data" :include="[/programs/]" />
 
+## Modular modules
+
+<RenderDocs :options="data" :include="[/^\<imports = \[ .* \]\>/]" />
+
 ## Outputs
 
 <RenderDocs :options="data" :include="/^build\.*/" />

docs/modular-modules.nix

@@ -0,0 +1,40 @@
+# https://github.com/NixOS/nixpkgs/blob/52c032768a8bd0c7a23fdad4232e50a2962079c2/nixos/modules/misc/documentation/modular-services.nix
+{ lib, pkgs, ... }:
+let
+  fakeSubmodule =
+    module:
+    lib.mkOption {
+      type = lib.types.submodule [
+        module
+        {
+          _file = ../modules;
+          options.wrappers =
+            lib.mapAttrs
+              (
+                name: _:
+                lib.mkOption {
+                  type = lib.types.submodule ../modules/wrapper.nix;
+                  description = "Wrapper created by option `${name}`.";
+                }
+              )
+              (lib.evalModules {
+                modules = [
+                  module
+                  {
+                    options.wrappers = lib.mkOption {
+                      type = lib.types.attrsOf (lib.types.submodule ../modules/wrapper.nix);
+                    };
+                  }
+                ];
+              }).config.wrappers;
+        }
+      ];
+      description = "This is a modular module (inspired by [modular service](https://nixos.org/manual/nixos/unstable/#modular-services)), which can be imported into a wrapper-manager configuration using the `wrappers` option.";
+    };
+
+  modularModulesModule = {
+    _file = "${__curPos.file}#L${toString __curPos.line}";
+    options = { };
+  };
+in
+modularModulesModule

docs/package.nix

@@ -9,10 +9,19 @@ let
   options_json =
     (nixosOptionsDoc {
       options =
-        ((import ../.).lib {
-          inherit pkgs;
-          modules = [ ];
-        }).options;
+        lib.recursiveUpdate
+          ((import ../.).lib {
+            inherit pkgs;
+            modules = [ ./modular-modules.nix ];
+          }).options
+          {
+            wrappers.type = lib.types.attrsOf (
+              lib.types.submodule [
+                ../modules/wrapper.nix
+                (pkgs.extend (import ../.).overlays.default).mkWrapper.modules.wrapped
+              ]
+            );
+          };
     }).optionsJSON;
 in
 buildNpmPackage {

modules/default.nix

@@ -77,7 +77,10 @@ in
           ./wrapper.nix
         ];
       });
-      description = "Wrappers to create.";
+      description = ''
+        Wrappers to create.
+
+        Also a collection of [modular modules](#modular-modules) that are configured as wrappers.'';
       example = lib.literalExpression ''
         {
           hello = {