diff --git a/lib.nix b/lib.nix index 2d38daa..a57d687 100644 --- a/lib.nix +++ b/lib.nix @@ -109,7 +109,7 @@ let ${name} = mkOption { type = types.lazyAttrsOf option.type; default = { }; - description = lib.mdDoc '' + description = '' See {option}`perSystem.${name}` for description and examples. ''; }; diff --git a/modules/apps.nix b/modules/apps.nix index f763700..dcd5b09 100644 --- a/modules/apps.nix +++ b/modules/apps.nix @@ -27,13 +27,13 @@ let type = mkOption { type = lib.types.enum [ "app" ]; default = "app"; - description = lib.mdDoc '' + description = '' A type tag for `apps` consumers. ''; }; program = mkOption { type = programType; - description = lib.mdDoc '' + description = '' A path to an executable or a derivation with `meta.mainProgram`. ''; }; diff --git a/modules/darwinModules.nix b/modules/darwinModules.nix index 3927c47..2e39a00 100644 --- a/modules/darwinModules.nix +++ b/modules/darwinModules.nix @@ -18,7 +18,7 @@ in type = types.lazyAttrsOf types.unspecified; default = { }; apply = mapAttrs (k: v: { _file = "${toString self.outPath}/flake.nix#darwinModules.${k}"; imports = [ v ]; }); - description = lib.mdDoc '' + description = '' [nix-darwin](https://daiderd.com/nix-darwin/) modules. ''; }; diff --git a/modules/flake.nix b/modules/flake.nix index 36382cc..884b2de 100644 --- a/modules/flake.nix +++ b/modules/flake.nix @@ -16,7 +16,7 @@ in { freeformType = types.lazyAttrsOf types.raw; } ]; }; - description = lib.mdDoc '' + description = '' Raw flake output attributes. Any attribute can be set here, but some attributes are represented by options, to provide appropriate configuration merging. diff --git a/modules/nixosConfigurations.nix b/modules/nixosConfigurations.nix index 01dea7f..7ddffd2 100644 --- a/modules/nixosConfigurations.nix +++ b/modules/nixosConfigurations.nix @@ -15,7 +15,7 @@ in nixosConfigurations = mkOption { type = types.lazyAttrsOf types.raw; default = { }; - description = lib.mdDoc '' + description = '' Instantiated NixOS configurations. Used by `nixos-rebuild`. ''; example = literalExpression '' diff --git a/modules/nixosModules.nix b/modules/nixosModules.nix index f5ca608..1d21f9e 100644 --- a/modules/nixosModules.nix +++ b/modules/nixosModules.nix @@ -18,7 +18,7 @@ in type = types.lazyAttrsOf types.unspecified; default = { }; apply = mapAttrs (k: v: { _file = "${toString self.outPath}/flake.nix#nixosModules.${k}"; imports = [ v ]; }); - description = lib.mdDoc '' + description = '' NixOS modules. You may use this for reusable pieces of configuration, service modules, etc. diff --git a/modules/overlays.nix b/modules/overlays.nix index eef0616..86fc457 100644 --- a/modules/overlays.nix +++ b/modules/overlays.nix @@ -23,7 +23,7 @@ in default = final: prev: {}; } ''; - description = lib.mdDoc '' + description = '' An attribute set of [overlays](https://nixos.org/manual/nixpkgs/stable/#chap-overlays). Note that the overlays themselves are not mergeable. While overlays diff --git a/modules/perSystem.nix b/modules/perSystem.nix index 2b19b28..9c5f62d 100644 --- a/modules/perSystem.nix +++ b/modules/perSystem.nix @@ -16,7 +16,7 @@ in { options = { systems = mkOption { - description = lib.mdDoc '' + description = '' All the system types to enumerate in the flake output subattributes. In other words, all valid values for `system` in e.g. `packages..foo`. @@ -25,12 +25,12 @@ in }; perInput = mkOption { - description = lib.mdDoc "Function from system to function from flake to `system`-specific attributes."; + description = "Function from system to function from flake to `system`-specific attributes."; type = types.functionTo (types.functionTo (types.lazyAttrsOf types.unspecified)); }; perSystem = mkOption { - description = lib.mdDoc "A function from system to flake-like attributes omitting the `` attribute."; + description = "A function from system to flake-like attributes omitting the `` attribute."; type = mkPerSystemType ({ config, system, ... }: { _file = ./perSystem.nix; config = { @@ -50,7 +50,7 @@ in allSystems = mkOption { type = types.lazyAttrsOf types.unspecified; - description = lib.mdDoc "The system-specific config for each of systems."; + description = "The system-specific config for each of systems."; internal = true; }; }; diff --git a/modules/transposition.nix b/modules/transposition.nix index 8e56d59..5ddfcd0 100644 --- a/modules/transposition.nix +++ b/modules/transposition.nix @@ -17,7 +17,7 @@ let adHoc = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to provide a stub option declaration for {option}`perSystem.`. The stub option declaration does not support merging and lacks @@ -32,7 +32,7 @@ in { options = { transposition = lib.mkOption { - description = lib.mdDoc '' + description = '' A helper that defines transposed attributes in the flake outputs. Transposition is the operation that swaps the indices of a data structure.