Files
nixpkgs/nixos/modules/misc/documentation/modular-services.nix
2026-05-27 23:54:14 +02:00

38 lines
1.5 KiB
Nix

/**
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 = {
options = {
"<imports = [ pkgs.autopush-rs.services.autoconnect ]>" =
fakeSubmodule pkgs.autopush-rs.services.autoconnect;
"<imports = [ pkgs.autopush-rs.services.autoendpoint ]>" =
fakeSubmodule pkgs.autopush-rs.services.autoendpoint;
"<imports = [ pkgs.ghostunnel.services.default ]>" = fakeSubmodule pkgs.ghostunnel.services.default;
"<imports = [ pkgs.ktls-utils.services.default ]>" = fakeSubmodule pkgs.ktls-utils.services.default;
"<imports = [ pkgs.php.services.default ]>" = fakeSubmodule pkgs.php.services.default;
"<imports = [ pkgs.snid.services.default ]>" = fakeSubmodule pkgs.snid.services.default;
};
};
in
{
documentation.nixos.extraModules = [
modularServicesModule
];
}