gendoc.py
114 lines
| 3.1 KiB
| text/x-python
|
PythonLexer
/ doc / gendoc.py
|
r9484 | import os, sys | ||
|
r1814 | # import from the live mercurial repo | ||
sys.path.insert(0, "..") | ||||
|
r9130 | # fall back to pure modules if required C extensions are not available | ||
sys.path.append(os.path.join('..', 'mercurial', 'pure')) | ||||
|
r5209 | from mercurial import demandimport; demandimport.enable() | ||
|
r9485 | from mercurial import encoding | ||
|
r1814 | from mercurial.commands import table, globalopts | ||
|
r9240 | from mercurial.i18n import _ | ||
|
r3797 | from mercurial.help import helptable | ||
|
r1814 | |||
def get_desc(docstr): | ||||
if not docstr: | ||||
return "", "" | ||||
# sanitize | ||||
docstr = docstr.strip("\n") | ||||
docstr = docstr.rstrip() | ||||
shortdesc = docstr.splitlines()[0].strip() | ||||
i = docstr.find("\n") | ||||
if i != -1: | ||||
desc = docstr[i+2:] | ||||
else: | ||||
desc = " %s" % shortdesc | ||||
return (shortdesc, desc) | ||||
def get_opts(opts): | ||||
for shortopt, longopt, default, desc in opts: | ||||
allopts = [] | ||||
if shortopt: | ||||
allopts.append("-%s" % shortopt) | ||||
if longopt: | ||||
allopts.append("--%s" % longopt) | ||||
desc += default and _(" (default: %s)") % default or "" | ||||
yield(", ".join(allopts), desc) | ||||
def get_cmd(cmd): | ||||
d = {} | ||||
attr = table[cmd] | ||||
cmds = cmd.lstrip("^").split("|") | ||||
d['cmd'] = cmds[0] | ||||
d['aliases'] = cmd.split("|")[1:] | ||||
d['desc'] = get_desc(attr[0].__doc__) | ||||
d['opts'] = list(get_opts(attr[1])) | ||||
|
r7376 | |||
s = 'hg ' + cmds[0] | ||||
if len(attr) > 2: | ||||
if not attr[2].startswith('hg'): | ||||
|
r8546 | s += ' ' + attr[2] | ||
|
r7376 | else: | ||
s = attr[2] | ||||
|
r9622 | d['synopsis'] = s.strip() | ||
|
r7376 | |||
|
r1814 | return d | ||
def show_doc(ui): | ||||
|
r9296 | def section(s): | ||
|
r9485 | ui.write("%s\n%s\n\n" % (s, "-" * encoding.colwidth(s))) | ||
|
r9296 | def subsection(s): | ||
|
r9485 | ui.write("%s\n%s\n\n" % (s, '"' * encoding.colwidth(s))) | ||
|
r1814 | |||
# print options | ||||
|
r9296 | section(_("OPTIONS")) | ||
|
r1814 | for optstr, desc in get_opts(globalopts): | ||
|
r9158 | ui.write("%s\n %s\n\n" % (optstr, desc)) | ||
|
r1814 | |||
# print cmds | ||||
|
r9296 | section(_("COMMANDS")) | ||
|
r1814 | h = {} | ||
for c, attr in table.items(): | ||||
|
r6488 | f = c.split("|")[0] | ||
f = f.lstrip("^") | ||||
h[f] = c | ||||
|
r1814 | cmds = h.keys() | ||
cmds.sort() | ||||
for f in cmds: | ||||
|
r6488 | if f.startswith("debug"): continue | ||
d = get_cmd(h[f]) | ||||
# synopsis | ||||
|
r9158 | ui.write(".. _%s:\n\n" % d['cmd']) | ||
ui.write("``%s``\n" % d['synopsis'].replace("hg ","", 1)) | ||||
|
r6488 | # description | ||
ui.write("%s\n\n" % d['desc'][1]) | ||||
# options | ||||
opt_output = list(d['opts']) | ||||
if opt_output: | ||||
opts_len = max([len(line[0]) for line in opt_output]) | ||||
|
r9158 | ui.write(_(" options:\n\n")) | ||
|
r6488 | for optstr, desc in opt_output: | ||
if desc: | ||||
s = "%-*s %s" % (opts_len, optstr, desc) | ||||
else: | ||||
s = optstr | ||||
|
r9484 | ui.write(" %s\n" % s) | ||
|
r6488 | ui.write("\n") | ||
# aliases | ||||
if d['aliases']: | ||||
ui.write(_(" aliases: %s\n\n") % " ".join(d['aliases'])) | ||||
|
r1814 | |||
|
r3797 | # print topics | ||
|
r9296 | for names, sec, doc in helptable: | ||
|
r9297 | for name in names: | ||
ui.write(".. _%s:\n" % name) | ||||
ui.write("\n") | ||||
|
r9296 | section(sec.upper()) | ||
|
r3797 | if callable(doc): | ||
doc = doc() | ||||
|
r9021 | ui.write(doc) | ||
|
r3797 | ui.write("\n") | ||
|
r1814 | if __name__ == "__main__": | ||
show_doc(sys.stdout) | ||||