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

docs: Fix heading levels

Browse Source
This commit is contained in:
Florian Bruhin 2014-09-07 21:09:21 +02:00
parent fc70d700b2
commit 9e3f5e28bc
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
scripts/generate_doc.py
View File

@ -143,7 +143,7 @@ def _get_setting_quickref():
def _get_command_doc(name, cmd): def _get_command_doc(name, cmd):
"""Generate the documentation for a command.""" """Generate the documentation for a command."""
output = ['[[{}]]'.format(name)] output = ['[[{}]]'.format(name)]
output += ['==== {}'.format(name)] output += ['=== {}'.format(name)]
syntax = _get_cmd_syntax(name, cmd) syntax = _get_cmd_syntax(name, cmd)
if syntax != name: if syntax != name:
output.append('Syntax: +:{}+'.format(syntax)) output.append('Syntax: +:{}+'.format(syntax))
@ -156,7 +156,7 @@ def _get_command_doc(name, cmd):
if cmd.pos_args: if cmd.pos_args:
output.append("") output.append("")
output.append('===== {}'.format("positional arguments")) output.append("==== positional arguments")
for arg in cmd.pos_args: for arg in cmd.pos_args:
try: try:
output.append('* +{}+: {}'.format(arg, parser.arg_descs[arg])) output.append('* +{}+: {}'.format(arg, parser.arg_descs[arg]))
@ -166,7 +166,7 @@ def _get_command_doc(name, cmd):
if cmd.opt_args: if cmd.opt_args:
output.append("") output.append("")
output.append('===== {}'.format("optional arguments")) output.append("==== optional arguments")
for arg, (long_flag, short_flag) in cmd.opt_args.items(): for arg, (long_flag, short_flag) in cmd.opt_args.items():
try: try:
output.append('* +{}+, +{}+: {}'.format( output.append('* +{}+, +{}+: {}'.format(
@ -229,7 +229,7 @@ def generate_commands(filename):
"""Generate the complete commands section.""" """Generate the complete commands section."""
with _open_file(filename) as f: with _open_file(filename) as f:
f.write('\n') f.write('\n')
f.write("== COMMANDS\n") f.write("= Commands\n")
normal_cmds = [] normal_cmds = []
hidden_cmds = [] hidden_cmds = []
debug_cmds = [] debug_cmds = []
@ -244,19 +244,19 @@ def generate_commands(filename):
hidden_cmds.sort() hidden_cmds.sort()
debug_cmds.sort() debug_cmds.sort()
f.write("\n") f.write("\n")
f.write("=== Normal commands\n") f.write("== Normal commands\n")
f.write(".Quick reference\n") f.write(".Quick reference\n")
f.write(_get_command_quickref(normal_cmds) + "\n\n") f.write(_get_command_quickref(normal_cmds) + "\n\n")
for name, cmd in normal_cmds: for name, cmd in normal_cmds:
f.write(_get_command_doc(name, cmd)) f.write(_get_command_doc(name, cmd))
f.write("\n") f.write("\n")
f.write("=== Hidden commands\n") f.write("== Hidden commands\n")
f.write(".Quick reference\n") f.write(".Quick reference\n")
f.write(_get_command_quickref(hidden_cmds)) f.write(_get_command_quickref(hidden_cmds))
for name, cmd in hidden_cmds: for name, cmd in hidden_cmds:
f.write(_get_command_doc(name, cmd)) f.write(_get_command_doc(name, cmd))
f.write("\n") f.write("\n")
f.write("=== Debugging commands\n") f.write("== Debugging commands\n")
f.write("These commands are mainly intended for debugging. They are " f.write("These commands are mainly intended for debugging. They are "
"hidden if qutebrowser was started without the " "hidden if qutebrowser was started without the "
"`--debug`-flag.\n") "`--debug`-flag.\n")
@ -271,11 +271,11 @@ 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:
f.write("\n") f.write("\n")
f.write("== SETTINGS\n") f.write("= Settings\n")
f.write(_get_setting_quickref() + "\n") f.write(_get_setting_quickref() + "\n")
for sectname, sect in configdata.DATA.items(): for sectname, sect in configdata.DATA.items():
f.write("\n") f.write("\n")
f.write("=== {}".format(sectname) + "\n") f.write("== {}".format(sectname) + "\n")
f.write(configdata.SECTION_DESC[sectname] + "\n") f.write(configdata.SECTION_DESC[sectname] + "\n")
if not getattr(sect, 'descriptions'): if not getattr(sect, 'descriptions'):
pass pass
@ -283,7 +283,7 @@ def generate_settings(filename):
for optname, option in sect.items(): for optname, option in sect.items():
f.write("\n") f.write("\n")
f.write('[[{}-{}]]'.format(sectname, optname) + "\n") f.write('[[{}-{}]]'.format(sectname, optname) + "\n")
f.write("==== {}".format(optname) + "\n") f.write("=== {}".format(optname) + "\n")
f.write(sect.descriptions[optname] + "\n") f.write(sect.descriptions[optname] + "\n")
f.write("\n") f.write("\n")
valid_values = option.typ.valid_values valid_values = option.typ.valid_values