blob: 70eeb2a6237ed34575c0ccf00bbaaaa49ba36e3a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
|
# nix-module-doc
Generate documentation for your NixOS-like modules.
`nix-module-doc` is capable of generating a markdown file, a manpage, and an
mkbook.
## Usage
In your `flake.nix`
```nix
{
inputs.nix-module-doc.url = "github:minijackson/nix-module-doc";
outputs = inputs: {
nixosModule.yourModule = let
docParams = {
# Where to store the outputs
outputAttrPath = ["your" "module" "outputs"];
# Where to store the documentation options
optionsAttrPath = ["your" "module" "doc"];
};
in {
imports = [
(inputs.nix-module-doc.lib.modules.doc-options-md docParams)
(inputs.nix-module-doc.lib.modules.manpage docParams)
(inputs.nix-module-doc.lib.modules.mdbook docParams)
];
}
};
}
```
|
