rnhmjoj/qutebrowser
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Split generate_settings in src2asciidoc.

Browse Source
This commit is contained in:
Florian Bruhin 2015-11-30 07:11:03 +01:00
parent 27d0c004e2
commit 2ba55a0e77
1 changed files with 27 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
scripts/dev/src2asciidoc.py
View File

@ -347,6 +347,32 @@ def generate_commands(filename):
f.write(_get_command_doc(name, cmd)) f.write(_get_command_doc(name, cmd))
def _generate_setting_section(f, sectname, sect):
"""Generate documentation for a single section."""
for optname, option in sect.items():
f.write("\n")
f.write('[[{}-{}]]'.format(sectname, optname) + "\n")
f.write("=== {}".format(optname) + "\n")
f.write(sect.descriptions[optname] + "\n")
f.write("\n")
valid_values = option.typ.valid_values
if valid_values is not None:
f.write("Valid values:\n")
f.write("\n")
for val in valid_values:
try:
desc = valid_values.descriptions[val]
f.write(" * +{}+: {}".format(val, desc) + "\n")
except KeyError:
f.write(" * +{}+".format(val) + "\n")
f.write("\n")
if option.default():
f.write("Default: +pass:[{}]+\n".format(html.escape(
option.default())))
else:
f.write("Default: empty\n")
def generate_settings(filename): def generate_settings(filename):
"""Generate the complete settings section.""" """Generate the complete settings section."""
with _open_file(filename) as f: with _open_file(filename) as f:
@ -359,28 +385,7 @@ def generate_settings(filename):
if not getattr(sect, 'descriptions'): if not getattr(sect, 'descriptions'):
pass pass
else: else:
for optname, option in sect.items(): _generate_setting_section(f, sectname, sect)
f.write("\n")
f.write('[[{}-{}]]'.format(sectname, optname) + "\n")
f.write("=== {}".format(optname) + "\n")
f.write(sect.descriptions[optname] + "\n")
f.write("\n")
valid_values = option.typ.valid_values
if valid_values is not None:
f.write("Valid values:\n")
f.write("\n")
for val in valid_values:
try:
desc = valid_values.descriptions[val]
f.write(" * +{}+: {}".format(val, desc) + "\n")
except KeyError:
f.write(" * +{}+".format(val) + "\n")
f.write("\n")
if option.default():
f.write("Default: +pass:[{}]+\n".format(html.escape(
option.default())))
else:
f.write("Default: empty\n")
def _get_authors(): def _get_authors():