movefasta/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-06-10 03:23:29 +03:00
Code Issues Projects Releases Packages Wiki Activity

nixosOptionsDoc: Add markdownByDefault parameter

Browse source
This commit is contained in:
Robert Hensing 2022-11-11 06:15:46 +01:00
parent d1fc8fa8b4
commit 429ba6c714
2 changed files with 10 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
nixos/lib/make-options-doc/mergeJSON.py
View file

@ -203,6 +203,9 @@ def convertMD(options: Dict[str, Any]) -> str:
for (name, option) in options.items():
if optionIs(option, 'description', 'mdDoc'):
option['description'] = convertString(name, option['description']['text'])
elif markdownByDefault:
option['description'] = convertString(name, option['description'])
if optionIs(option, 'example', 'literalMD'):
docbook = convertString(name, option['example']['text'])
option['example'] = { '_type': 'literalDocBook', 'text': docbook }
@ -214,6 +217,7 @@ def convertMD(options: Dict[str, Any]) -> str:
warningsAreErrors = False
errorOnDocbook = False
markdownByDefault = False
optOffset = 0
for arg in sys.argv[1:]:
if arg == "--warnings-are-errors":
@ -222,6 +226,9 @@ for arg in sys.argv[1:]:
if arg == "--error-on-docbook":
optOffset += 1
errorOnDocbook = True
if arg == "--markdown-by-default":
optOffset += 1
markdownByDefault = True
options = pivot(json.load(open(sys.argv[1 + optOffset], 'r')))
overrides = pivot(json.load(open(sys.argv[2 + optOffset], 'r')))