doc/manual: Hide internals by default
This commit is contained in:
parent
0637a1ace9
commit
6b5d0b988d
1 changed files with 8 additions and 4 deletions
|
@ -34,9 +34,6 @@ let
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
|
|
||||||
in
|
|
||||||
|
|
||||||
recurseIntoAttrs rec {
|
|
||||||
compositionOptions = options {
|
compositionOptions = options {
|
||||||
moduleType = "composition";
|
moduleType = "composition";
|
||||||
description = "List of Arion composition-level options in JSON format";
|
description = "List of Arion composition-level options in JSON format";
|
||||||
|
@ -52,6 +49,7 @@ recurseIntoAttrs rec {
|
||||||
in map fixPaths (lib.filter (opt: opt.visible && !opt.internal) (lib.optionAttrSetToDocList composition.options))
|
in map fixPaths (lib.filter (opt: opt.visible && !opt.internal) (lib.optionAttrSetToDocList composition.options))
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
|
|
||||||
serviceOptions = options {
|
serviceOptions = options {
|
||||||
moduleType = "service";
|
moduleType = "service";
|
||||||
description = "List of Arion service-level options in JSON format";
|
description = "List of Arion service-level options in JSON format";
|
||||||
|
@ -67,11 +65,13 @@ recurseIntoAttrs rec {
|
||||||
in map fixPaths (lib.filter (opt: opt.visible && !opt.internal) (lib.optionAttrSetToDocList composition.options))
|
in map fixPaths (lib.filter (opt: opt.visible && !opt.internal) (lib.optionAttrSetToDocList composition.options))
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
|
|
||||||
generatedDocBook = runCommand "generated-docbook" {} ''
|
generatedDocBook = runCommand "generated-docbook" {} ''
|
||||||
mkdir $out
|
mkdir $out
|
||||||
ln -s ${compositionOptions.optionsDocBook} $out/options-composition.xml
|
ln -s ${compositionOptions.optionsDocBook} $out/options-composition.xml
|
||||||
ln -s ${serviceOptions.optionsDocBook} $out/options-service.xml
|
ln -s ${serviceOptions.optionsDocBook} $out/options-service.xml
|
||||||
'';
|
'';
|
||||||
|
|
||||||
manual = stdenv.mkDerivation {
|
manual = stdenv.mkDerivation {
|
||||||
src = lib.sourceByRegex ./. [
|
src = lib.sourceByRegex ./. [
|
||||||
"Makefile$"
|
"Makefile$"
|
||||||
|
@ -116,5 +116,9 @@ recurseIntoAttrs rec {
|
||||||
done
|
done
|
||||||
}
|
}
|
||||||
'';
|
'';
|
||||||
|
passthru = {
|
||||||
|
inherit generatedDocBook;
|
||||||
|
};
|
||||||
};
|
};
|
||||||
}
|
in
|
||||||
|
manual
|
||||||
|
|
Loading…
Reference in a new issue