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

Add links to command quickref

Browse Source
This commit is contained in:
Florian Bruhin 2014-05-29 21:08:22 +02:00
parent dc107f94b9
commit 8b5e23dd66
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
scripts/generate_manpage.py
View File

@ -108,7 +108,7 @@ def get_command_quickref(cmds):
out.append('|Command|Description') out.append('|Command|Description')
for name, cmd in cmds: for name, cmd in cmds:
desc = inspect.getdoc(cmd.handler).splitlines()[0] desc = inspect.getdoc(cmd.handler).splitlines()[0]
out.append('|{}|{}'.format(name, desc)) out.append('|<<cmd-{},{}>>|{}'.format(name, name, desc))
out.append('|==============') out.append('|==============')
return '\n'.join(out) return '\n'.join(out)
@ -124,13 +124,15 @@ def get_setting_quickref():
out.append('|Setting|Description') out.append('|Setting|Description')
for optname, option in sect.items(): for optname, option in sect.items():
desc = sect.descriptions[optname] desc = sect.descriptions[optname]
out.append('|{}|{}'.format(optname, desc)) out.append('|<<setting-{}-{},{}>>|{}'.format(
sectname, optname, optname, desc))
out.append('|==============') out.append('|==============')
return '\n'.join(out) return '\n'.join(out)
def get_command_doc(name, cmd): def get_command_doc(name, cmd):
output = ['==== {}'.format(name)] output = ['[[cmd-{}]]'.format(name)]
output += ['==== {}'.format(name)]
syntax, defaults = get_cmd_syntax(name, cmd) syntax, defaults = get_cmd_syntax(name, cmd)
output.append('+:{}+'.format(syntax)) output.append('+:{}+'.format(syntax))
output.append("") output.append("")
@ -196,6 +198,7 @@ def generate_settings():
else: else:
for optname, option in sect.items(): for optname, option in sect.items():
print() print()
print('[[setting-{}-{}]]'.format(sectname, optname))
print("==== {}".format(optname)) print("==== {}".format(optname))
print(sect.descriptions[optname]) print(sect.descriptions[optname])
print() print()