summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicholas Schwab <git@nicholas-schwab.de>2021-04-08 17:17:14 +0200
committerNicholas Schwab <git@nicholas-schwab.de>2021-04-08 17:17:14 +0200
commit55134a0a7c38f9fb1069826b9c86b16fcce433fb (patch)
tree6a67e9208a2be3caf4ec26f0110e3de8b4524736
parent082f7562babfa97affc8823db896c85a8e3e1c93 (diff)
downloadqutebrowser-55134a0a7c38f9fb1069826b9c86b16fcce433fb.tar.gz
qutebrowser-55134a0a7c38f9fb1069826b9c86b16fcce433fb.zip
Added valid_prefixes to documentation creation.
-rwxr-xr-xscripts/dev/src2asciidoc.py27
1 files changed, 18 insertions, 9 deletions
diff --git a/scripts/dev/src2asciidoc.py b/scripts/dev/src2asciidoc.py
index 82bbdb167..6342a6180 100755
--- a/scripts/dev/src2asciidoc.py
+++ b/scripts/dev/src2asciidoc.py
@@ -435,6 +435,18 @@ def _generate_setting_backend_info(f, opt):
.format(opt.backends))
+def _format_valid_list(f, head, valid_list):
+ f.write(head)
+ f.write("\n")
+ for val in valid_list:
+ try:
+ desc = valid_list.descriptions[val]
+ f.write(" * +{}+: {}".format(val, desc) + "\n")
+ except KeyError:
+ f.write(" * +{}+".format(val) + "\n")
+ f.write("\n")
+
+
def _generate_setting_option(f, opt):
"""Generate documentation for a single section."""
f.write("\n")
@@ -455,15 +467,12 @@ def _generate_setting_option(f, opt):
valid_values = opt.typ.get_valid_values()
if valid_values is not None and valid_values.generate_docs:
- 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")
+ _format_valid_list(f, "Valid values:\n", valid_values)
+
+ valid_prefixes = opt.typ.get_valid_prefixes()
+ if valid_prefixes is not None and valid_prefixes.generate_docs:
+ _format_valid_list(f, "Valid prefixes (separator is +{}+):\n".format(
+ valid_prefixes.separator), valid_prefixes)
f.write("Default: {}\n".format(opt.typ.to_doc(opt.default)))