Mercurial > hg
view doc/gendoc.py @ 9627:4515761ea531
rst2man: avoid italic for references
The links to other manpages used both italic and bold text nested
within each other. The \fP (select previous font) macro was used
incorrectly to "reset" the nested fonts resulting in:
<roman> text <italic> <bold> hg <italic> (1) <bold> more text
with no switch back to roman. This stops the bleeding and removes the
ugly italic (underline) from the manpage links.
author | Martin Geisler <mg@lazybytes.net> |
---|---|
date | Thu, 22 Oct 2009 00:27:08 +0200 |
parents | 9d1a480ca6ea |
children | dd1a95ccbe07 |
line wrap: on
line source
import os, sys # import from the live mercurial repo sys.path.insert(0, "..") # fall back to pure modules if required C extensions are not available sys.path.append(os.path.join('..', 'mercurial', 'pure')) from mercurial import demandimport; demandimport.enable() from mercurial import encoding from mercurial.commands import table, globalopts from mercurial.i18n import _ from mercurial.help import helptable 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])) s = 'hg ' + cmds[0] if len(attr) > 2: if not attr[2].startswith('hg'): s += ' ' + attr[2] else: s = attr[2] d['synopsis'] = s.strip() return d def show_doc(ui): def section(s): ui.write("%s\n%s\n\n" % (s, "-" * encoding.colwidth(s))) def subsection(s): ui.write("%s\n%s\n\n" % (s, '"' * encoding.colwidth(s))) # print options section(_("OPTIONS")) for optstr, desc in get_opts(globalopts): ui.write("%s\n %s\n\n" % (optstr, desc)) # print cmds section(_("COMMANDS")) h = {} for c, attr in table.items(): f = c.split("|")[0] f = f.lstrip("^") h[f] = c cmds = h.keys() cmds.sort() for f in cmds: if f.startswith("debug"): continue d = get_cmd(h[f]) # synopsis ui.write(".. _%s:\n\n" % d['cmd']) ui.write("``%s``\n" % d['synopsis'].replace("hg ","", 1)) # 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]) ui.write(_(" options:\n\n")) for optstr, desc in opt_output: if desc: s = "%-*s %s" % (opts_len, optstr, desc) else: s = optstr ui.write(" %s\n" % s) ui.write("\n") # aliases if d['aliases']: ui.write(_(" aliases: %s\n\n") % " ".join(d['aliases'])) # print topics for names, sec, doc in helptable: for name in names: ui.write(".. _%s:\n" % name) ui.write("\n") section(sec.upper()) if callable(doc): doc = doc() ui.write(doc) ui.write("\n") if __name__ == "__main__": show_doc(sys.stdout)