inventory: add docs for available specialArgs in service submodules
This commit is contained in:
committed by
Mic92
parent
3d0c281fd6
commit
3ffad3f97f
@@ -38,7 +38,34 @@
|
|||||||
(pkgs.nixosOptionsDoc {
|
(pkgs.nixosOptionsDoc {
|
||||||
options =
|
options =
|
||||||
(self.clanLib.evalService {
|
(self.clanLib.evalService {
|
||||||
modules = [ { _docs_rendering = true; } ];
|
modules = [
|
||||||
|
{ _docs_rendering = true; }
|
||||||
|
{
|
||||||
|
options."#specialArgs" = lib.mkOption {
|
||||||
|
description = ''
|
||||||
|
Adidtional arguments passed to the module. Often referred to as `specialArgs`.
|
||||||
|
|
||||||
|
```nix
|
||||||
|
{
|
||||||
|
# root directory of the clan
|
||||||
|
directory,
|
||||||
|
# clanLib - The clan library functions
|
||||||
|
clanLib,
|
||||||
|
# exports from all services
|
||||||
|
exports,
|
||||||
|
...
|
||||||
|
}:
|
||||||
|
{
|
||||||
|
_class = "clan.service";
|
||||||
|
manifest.name = "example-service";
|
||||||
|
|
||||||
|
# ... elided
|
||||||
|
}
|
||||||
|
```
|
||||||
|
'';
|
||||||
|
};
|
||||||
|
}
|
||||||
|
];
|
||||||
prefix = [ ];
|
prefix = [ ];
|
||||||
}).options;
|
}).options;
|
||||||
warningsAreErrors = true;
|
warningsAreErrors = true;
|
||||||
|
|||||||
Reference in New Issue
Block a user