mirror of
https://github.com/NixOS/nixpkgs.git
synced 2024-11-16 14:54:29 +01:00
nixos/lib/make-options-doc: generate asciidoc/md in derivations
use the json file derivation we already have to also generate the asciidoc and md options docs instead of formatting the options in nix. docbook docs are already produced in derivations. the new script produce the exact same output as the old in-nix generation.
This commit is contained in:
parent
15e5f8ba8e
commit
4670400309
3 changed files with 75 additions and 63 deletions
|
@ -93,72 +93,20 @@ let
|
||||||
|
|
||||||
optionsNix = builtins.listToAttrs (map (o: { name = o.name; value = removeAttrs o ["name" "visible" "internal"]; }) optionsList);
|
optionsNix = builtins.listToAttrs (map (o: { name = o.name; value = removeAttrs o ["name" "visible" "internal"]; }) optionsList);
|
||||||
|
|
||||||
# TODO: declarations: link to github
|
in rec {
|
||||||
singleAsciiDoc = name: value: ''
|
|
||||||
== ${name}
|
|
||||||
|
|
||||||
${value.description}
|
|
||||||
|
|
||||||
[discrete]
|
|
||||||
=== details
|
|
||||||
|
|
||||||
Type:: ${value.type}
|
|
||||||
${ if lib.hasAttr "default" value
|
|
||||||
then ''
|
|
||||||
Default::
|
|
||||||
+
|
|
||||||
----
|
|
||||||
${builtins.toJSON value.default}
|
|
||||||
----
|
|
||||||
''
|
|
||||||
else "No Default:: {blank}"
|
|
||||||
}
|
|
||||||
${ if value.readOnly
|
|
||||||
then "Read Only:: {blank}"
|
|
||||||
else ""
|
|
||||||
}
|
|
||||||
${ if lib.hasAttr "example" value
|
|
||||||
then ''
|
|
||||||
Example::
|
|
||||||
+
|
|
||||||
----
|
|
||||||
${builtins.toJSON value.example}
|
|
||||||
----
|
|
||||||
''
|
|
||||||
else "No Example:: {blank}"
|
|
||||||
}
|
|
||||||
'';
|
|
||||||
|
|
||||||
singleMDDoc = name: value: ''
|
|
||||||
## ${lib.escape [ "<" ">" ] name}
|
|
||||||
${value.description}
|
|
||||||
|
|
||||||
${lib.optionalString (value ? type) ''
|
|
||||||
*_Type_*:
|
|
||||||
${value.type}
|
|
||||||
''}
|
|
||||||
|
|
||||||
${lib.optionalString (value ? default) ''
|
|
||||||
*_Default_*
|
|
||||||
```
|
|
||||||
${builtins.toJSON value.default}
|
|
||||||
```
|
|
||||||
''}
|
|
||||||
|
|
||||||
${lib.optionalString (value ? example) ''
|
|
||||||
*_Example_*
|
|
||||||
```
|
|
||||||
${builtins.toJSON value.example}
|
|
||||||
```
|
|
||||||
''}
|
|
||||||
'';
|
|
||||||
|
|
||||||
in {
|
|
||||||
inherit optionsNix;
|
inherit optionsNix;
|
||||||
|
|
||||||
optionsAsciiDoc = lib.concatStringsSep "\n" (lib.mapAttrsToList singleAsciiDoc optionsNix);
|
optionsAsciiDoc = pkgs.runCommand "options.adoc" {} ''
|
||||||
|
${pkgs.python3Minimal}/bin/python ${./generateAsciiDoc.py} \
|
||||||
|
< ${optionsJSON}/share/doc/nixos/options.json \
|
||||||
|
> $out
|
||||||
|
'';
|
||||||
|
|
||||||
optionsMDDoc = lib.concatStringsSep "\n" (lib.mapAttrsToList singleMDDoc optionsNix);
|
optionsCommonMark = pkgs.runCommand "options.md" {} ''
|
||||||
|
${pkgs.python3Minimal}/bin/python ${./generateCommonMark.py} \
|
||||||
|
< ${optionsJSON}/share/doc/nixos/options.json \
|
||||||
|
> $out
|
||||||
|
'';
|
||||||
|
|
||||||
optionsJSON = pkgs.runCommand "options.json"
|
optionsJSON = pkgs.runCommand "options.json"
|
||||||
{ meta.description = "List of NixOS options in JSON format";
|
{ meta.description = "List of NixOS options in JSON format";
|
||||||
|
|
37
nixos/lib/make-options-doc/generateAsciiDoc.py
Normal file
37
nixos/lib/make-options-doc/generateAsciiDoc.py
Normal file
|
@ -0,0 +1,37 @@
|
||||||
|
import json
|
||||||
|
import sys
|
||||||
|
|
||||||
|
options = json.load(sys.stdin)
|
||||||
|
# TODO: declarations: link to github
|
||||||
|
for (name, value) in options.items():
|
||||||
|
print(f'== {name}')
|
||||||
|
print()
|
||||||
|
print(value['description'])
|
||||||
|
print()
|
||||||
|
print('[discrete]')
|
||||||
|
print('=== details')
|
||||||
|
print()
|
||||||
|
print(f'Type:: {value["type"]}')
|
||||||
|
if 'default' in value:
|
||||||
|
print('Default::')
|
||||||
|
print('+')
|
||||||
|
print('----')
|
||||||
|
print(json.dumps(value['default'], ensure_ascii=False, separators=(',', ':')))
|
||||||
|
print('----')
|
||||||
|
print()
|
||||||
|
else:
|
||||||
|
print('No Default:: {blank}')
|
||||||
|
if value['readOnly']:
|
||||||
|
print('Read Only:: {blank}')
|
||||||
|
else:
|
||||||
|
print()
|
||||||
|
if 'example' in value:
|
||||||
|
print('Example::')
|
||||||
|
print('+')
|
||||||
|
print('----')
|
||||||
|
print(json.dumps(value['example'], ensure_ascii=False, separators=(',', ':')))
|
||||||
|
print('----')
|
||||||
|
print()
|
||||||
|
else:
|
||||||
|
print('No Example:: {blank}')
|
||||||
|
print()
|
27
nixos/lib/make-options-doc/generateCommonMark.py
Normal file
27
nixos/lib/make-options-doc/generateCommonMark.py
Normal file
|
@ -0,0 +1,27 @@
|
||||||
|
import json
|
||||||
|
import sys
|
||||||
|
|
||||||
|
options = json.load(sys.stdin)
|
||||||
|
for (name, value) in options.items():
|
||||||
|
print('##', name.replace('<', '\\<').replace('>', '\\>'))
|
||||||
|
print(value['description'])
|
||||||
|
print()
|
||||||
|
if 'type' in value:
|
||||||
|
print('*_Type_*:')
|
||||||
|
print(value['type'])
|
||||||
|
print()
|
||||||
|
print()
|
||||||
|
if 'default' in value:
|
||||||
|
print('*_Default_*')
|
||||||
|
print('```')
|
||||||
|
print(json.dumps(value['default'], ensure_ascii=False, separators=(',', ':')))
|
||||||
|
print('```')
|
||||||
|
print()
|
||||||
|
print()
|
||||||
|
if 'example' in value:
|
||||||
|
print('*_Example_*')
|
||||||
|
print('```')
|
||||||
|
print(json.dumps(value['example'], ensure_ascii=False, separators=(',', ':')))
|
||||||
|
print('```')
|
||||||
|
print()
|
||||||
|
print()
|
Loading…
Reference in a new issue