pyrox.dev
1{ lib, ... }:
2let
3 docFile = lib.types.path // {
4 # Returns tuples of
5 # { file = "module location"; value = <path/to/doc.xml>; }
6 merge = loc: defs: defs;
7 };
8in
9
10{
11 imports = [ ../../../modules/generic/meta-maintainers.nix ];
12
13 options = {
14 meta = {
15
16 doc = lib.mkOption {
17 type = docFile;
18 internal = true;
19 example = "./meta.chapter.md";
20 description = ''
21 Documentation prologue for the set of options of each module. This
22 option should be defined at most once per module.
23 '';
24 };
25
26 buildDocsInSandbox = lib.mkOption {
27 type = lib.types.bool // {
28 merge = loc: defs: defs;
29 };
30 internal = true;
31 default = true;
32 description = ''
33 Whether to include this module in the split options doc build.
34 Disable if the module references `config`, `pkgs` or other module
35 arguments that cannot be evaluated as constants.
36
37 This option should be defined at most once per module.
38 '';
39 };
40
41 };
42 };
43
44 meta.maintainers = with lib.maintainers; [
45 pierron
46 roberth
47 ];
48}