push sheeet

nixos/modules/misc/documentation/modular-services.nix

@@ -0,0 +1,32 @@
+/**
+  Renders documentation for modular services.
+  For inclusion into documentation.nixos.extraModules.
+*/
+{ lib, pkgs, ... }:
+let
+  /**
+    Causes a modular service's docs to be rendered.
+    This is an intermediate solution until we have "native" service docs in some nicer form.
+  */
+  fakeSubmodule =
+    module:
+    lib.mkOption {
+      type = lib.types.submoduleWith {
+        modules = [ module ];
+      };
+      description = "This is a [modular service](https://nixos.org/manual/nixos/unstable/#modular-services), which can be imported into a NixOS configuration using the [`system.services`](https://search.nixos.org/options?channel=unstable&show=system.services&query=modular+service) option.";
+    };
+
+  modularServicesModule = {
+    _file = "${__curPos.file}:${toString __curPos.line}";
+    options = {
+      "<imports = [ pkgs.ghostunnel.services.default ]>" = fakeSubmodule pkgs.ghostunnel.services.default;
+      "<imports = [ pkgs.php.services.default ]>" = fakeSubmodule pkgs.php.services.default;
+    };
+  };
+in
+{
+  documentation.nixos.extraModules = [
+    modularServicesModule
+  ];
+}

nixos/modules/misc/documentation/test.nix

@@ -0,0 +1,59 @@
+{
+  nixosLib,
+  pkgsModule,
+  runCommand,
+}:
+
+let
+  sys = nixosLib.evalModules rec {
+    modules = [
+      pkgsModule
+      ../documentation.nix
+      ../version.nix
+
+      (
+        { lib, someArg, ... }:
+        {
+          # Make sure imports from specialArgs are respected
+          imports = [ someArg.myModule ];
+
+          # TODO test this
+          meta.doc = ./test-dummy.chapter.xml;
+        }
+      )
+
+      {
+        _module.args = {
+          baseModules = [
+            ../documentation.nix
+            ../version.nix
+          ];
+          extraModules = [ ];
+          inherit modules;
+        };
+        documentation.nixos.includeAllModules = true;
+      }
+    ];
+    specialArgs.someArg.myModule =
+      { lib, ... }:
+      {
+        options.foobar = lib.mkOption {
+          type = lib.types.str;
+          description = "The foobar option was added via specialArgs";
+          default = "qux";
+        };
+      };
+  };
+
+in
+runCommand "documentation-check"
+  {
+    inherit (sys.config.system.build.manual) optionsJSON;
+  }
+  ''
+    json="$optionsJSON/share/doc/nixos/options.json"
+    echo checking $json
+
+    grep 'The foobar option was added via specialArgs' <"$json" >/dev/null
+    touch $out
+  ''