alioth/nixpkgs
3
0
Fork 0
forked from mirrors/nixpkgs
Code Releases Activity

nixos/make-options-doc: render option types through md

Browse source 
no changes to rendered output, but options.xml loses a few spaces.
This commit is contained in:
pennae 2023-01-25 00:21:13 +01:00
parent 6b677d9148
commit de22a26b4c
1 changed files with 18 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
nixos/lib/make-options-doc/optionsToDocbook.py
View file

@ -263,6 +263,10 @@ def convertMD(options: Dict[str, Any]) -> str:
convertCode(name, option, 'example')
convertCode(name, option, 'default')
if typ := option.get('type'):
ro = " *(read only)*" if option.get('readOnly', False) else ""
option['type'] = md.render(f'*Type:* {md_escape(typ)}{ro}')
if 'relatedPackages' in option:
option['relatedPackages'] = md.render(option['relatedPackages'])
except Exception as e:
@ -281,6 +285,19 @@ id_translate_table = {
ord('"'): ord('_'),
}
md_escape_table = {
ord('*'): '\\*',
ord('<'): '\\<',
ord('['): '\\[',
ord('`'): '\\`',
ord('.'): '\\.',
ord('#'): '\\#',
ord('&'): '\\&',
ord('\\'): '\\\\',
}
def md_escape(s: str) -> str:
return s.translate(md_escape_table)
def need_env(n):
if n not in os.environ:
raise RuntimeError("required environment variable not set", n)
@ -358,8 +375,7 @@ for name in keys:
print(f"""<listitem>""")
print(opt['description'])
if typ := opt.get('type'):
ro = " <emphasis>(read only)</emphasis>" if opt.get('readOnly', False) else ""
print(f"""<para><emphasis>Type:</emphasis> {escape(typ)}{ro}</para>""")
print(typ)
if default := opt.get('default'):
print(default)
if example := opt.get('example'):