nixos/documentation/modular-services: init (#430876)

/**

  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;

    };

  };

in

{

  documentation.nixos.extraModules = [

    modularServicesModule

  ];

}

  ./misc/assertions.nix

  ./misc/crashdump.nix

  ./misc/documentation.nix

  ./misc/documentation/modular-services.nix

  ./misc/extra-arguments.nix

  ./misc/ids.nix

  ./misc/label.nix