mirror of
https://github.com/NixOS/nixpkgs.git
synced 2025-11-10 09:43:30 +01:00
0c156a7144
This factors out `meta.maintainers` from NixOS `misc/meta.nix` for use in arbitrary Module System applications. It is useful beyond NixOS and not coupled to it, although it is currently coupled to Nixpkgs' `lib.maintainers`. That restriction could be lifted optionally if there's future demand.
49 lines
1.1 KiB
Nix
49 lines
1.1 KiB
Nix
{ lib, ... }:
|
|
let
|
|
docFile = lib.types.path // {
|
|
# Returns tuples of
|
|
# { file = "module location"; value = <path/to/doc.xml>; }
|
|
merge = loc: defs: defs;
|
|
};
|
|
in
|
|
|
|
{
|
|
imports = [ ../../../modules/generic/meta-maintainers.nix ];
|
|
|
|
options = {
|
|
meta = {
|
|
|
|
doc = lib.mkOption {
|
|
type = docFile;
|
|
internal = true;
|
|
example = "./meta.chapter.md";
|
|
description = ''
|
|
Documentation prologue for the set of options of each module. This
|
|
option should be defined at most once per module.
|
|
'';
|
|
};
|
|
|
|
buildDocsInSandbox = lib.mkOption {
|
|
type = lib.types.bool // {
|
|
merge = loc: defs: defs;
|
|
};
|
|
internal = true;
|
|
default = true;
|
|
description = ''
|
|
Whether to include this module in the split options doc build.
|
|
Disable if the module references `config`, `pkgs` or other module
|
|
arguments that cannot be evaluated as constants.
|
|
|
|
This option should be defined at most once per module.
|
|
'';
|
|
};
|
|
|
|
};
|
|
};
|
|
|
|
meta.maintainers = with lib.maintainers; [
|
|
pierron
|
|
roberth
|
|
];
|
|
}
|