Mercurial > hg
view doc/runrst @ 12781:0d09991f91ee
gendoc: automatically create help for default extensions.
Adds a section in the hg.1 manpage and corresponding hg.1.html
file. Each extension is listed with its module docstring, followed by
the commands defined by that extendsion.
Creates help for extensions by extracting doc strings from the extension modules
and its commands.
author | Erik Zielke <ez@aragost.com> |
---|---|
date | Wed, 20 Oct 2010 17:45:09 +0200 |
parents | 13d79a7bf5b7 |
children | 1ae824142c01 |
line wrap: on
line source
#!/usr/bin/env python # # runrst - register custom roles and run correct writer # # Copyright 2010 Matt Mackall <mpm@selenic.com> and others # # This software may be used and distributed according to the terms of the # GNU General Public License version 2 or any later version. """usage: %s WRITER args... where WRITER is the name of a Docutils writer such as 'html' or 'manpage' """ import sys try: from docutils.parsers.rst import roles from docutils.core import publish_cmdline from docutils import nodes, utils except ImportError: sys.stderr.write("abort: couldn't generate documentation: docutils " "module is missing\n") sys.exit(-1) def role_hg(name, rawtext, text, lineno, inliner, options={}, content=[]): text = "hg " + utils.unescape(text) linktext = nodes.literal(rawtext, text) parts = text.split() cmd, args = parts[1], parts[2:] if cmd == 'help' and args: cmd = args[0] # link to 'dates' for 'hg help dates' node = nodes.reference(rawtext, '', linktext, refuri="hg.1.html#%s" % cmd) return [node], [] roles.register_local_role("hg", role_hg) if __name__ == "__main__": if len(sys.argv) < 2: sys.stderr.write(__doc__ % sys.argv[0]) sys.exit(1) writer = sys.argv[1] del sys.argv[1] publish_cmdline(writer_name=writer)