mercurial-scm/hg-stable: doc/gendoc.py annotate

annotate doc/gendoc.py @ 20655:37f3be9d1541

doc: gendoc.py creates valid output for option descriptions with newlines gendoc.py did not handle the hanging indentation for descriptions. Work around this by joining all in one single line (same as in minirst since previous patch). This problem occurred when translations of option lines were very long. Do not bother the translators with this detail. On a long option description, the translator continued on a new line as usual. gendoc.py created invalid rst syntax like this: -o, --option Description line 1 description line 2 The new output is: -o, --option Description line 1 description line 2 The lines could theoretically become very long, but line breaking is handled when generating the final documentation.

author	Simon Heimberg <simohe@besonet.ch>
date	Thu, 20 Feb 2014 09:17:22 +0100
parents	93f9d11603d8
children	401f9b661a2d

rev	line source
19425 81fbd4e66ff5 gendoc: dispatch print document content by commandline arguments Takumi IINO <trot.thunder@gmail.com> parents: 19424 diff changeset	1 """usage: %s DOC ...
81fbd4e66ff5 gendoc: dispatch print document content by commandline arguments Takumi IINO <trot.thunder@gmail.com> parents: 19424 diff changeset	2
81fbd4e66ff5 gendoc: dispatch print document content by commandline arguments Takumi IINO <trot.thunder@gmail.com> parents: 19424 diff changeset	3 where DOC is the name of a document
81fbd4e66ff5 gendoc: dispatch print document content by commandline arguments Takumi IINO <trot.thunder@gmail.com> parents: 19424 diff changeset	4 """
81fbd4e66ff5 gendoc: dispatch print document content by commandline arguments Takumi IINO <trot.thunder@gmail.com> parents: 19424 diff changeset	5
12780 bdc1cf692447 gendoc: dedent documentation from docstrings Erik Zielke <ez@aragost.com> parents: 12777 diff changeset	6 import os, sys, textwrap
1814 7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	7 # import from the live mercurial repo
7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	8 sys.path.insert(0, "..")
9130 335f749cc369 gendoc: fall back to pure modules if C extensions are not available (issue1711) C?dric Duval <cedricduval@free.fr> parents: 9021 diff changeset	9 # fall back to pure modules if required C extensions are not available
335f749cc369 gendoc: fall back to pure modules if C extensions are not available (issue1711) C?dric Duval <cedricduval@free.fr> parents: 9021 diff changeset	10 sys.path.append(os.path.join('..', 'mercurial', 'pure'))
5209 bbdcdc7f170e gendoc: use demandimport Matt Mackall <mpm@selenic.com> parents: 3797 diff changeset	11 from mercurial import demandimport; demandimport.enable()
18748 6e676fb6ea44 help: use a full header for topic titles Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17267 diff changeset	12 from mercurial import minirst
1814 7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	13 from mercurial.commands import table, globalopts
19231 814291b5e79c gendoc: make commnd __doc__ and extension __doc__ as translatable Takumi IINO <trot.thunder@gmail.com> parents: 18748 diff changeset	14 from mercurial.i18n import gettext, _
19424 762e51ce3411 gendoc: add showtopic Takumi IINO <trot.thunder@gmail.com> parents: 19423 diff changeset	15 from mercurial.help import helptable, loaddoc
12781 0d09991f91ee gendoc: automatically create help for default extensions. Erik Zielke <ez@aragost.com> parents: 12780 diff changeset	16 from mercurial import extensions
14943 d3bb825ddae3 globally: use safehasattr(x, '__call__') instead of hasattr(x, '__call__') Augie Fackler <durin42@gmail.com> parents: 14461 diff changeset	17 from mercurial import util
1814 7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	18
7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	19 def get_desc(docstr):
7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	20 if not docstr:
7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	21 return "", ""
7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	22 # sanitize
7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	23 docstr = docstr.strip("\n")
7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	24 docstr = docstr.rstrip()
7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	25 shortdesc = docstr.splitlines()[0].strip()
7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	26
7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	27 i = docstr.find("\n")
7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	28 if i != -1:
10282 08a0f04b56bd many, many trivial check-code fixups Matt Mackall <mpm@selenic.com> parents: 9792 diff changeset	29 desc = docstr[i + 2:]
1814 7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	30 else:
12780 bdc1cf692447 gendoc: dedent documentation from docstrings Erik Zielke <ez@aragost.com> parents: 12777 diff changeset	31 desc = shortdesc
bdc1cf692447 gendoc: dedent documentation from docstrings Erik Zielke <ez@aragost.com> parents: 12777 diff changeset	32
bdc1cf692447 gendoc: dedent documentation from docstrings Erik Zielke <ez@aragost.com> parents: 12777 diff changeset	33 desc = textwrap.dedent(desc)
bdc1cf692447 gendoc: dedent documentation from docstrings Erik Zielke <ez@aragost.com> parents: 12777 diff changeset	34
1814 7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	35 return (shortdesc, desc)
7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	36
7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	37 def get_opts(opts):
11321 40c06bbf58be help: show value requirement and multiple occurrence of options FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 10282 diff changeset	38 for opt in opts:
40c06bbf58be help: show value requirement and multiple occurrence of options FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 10282 diff changeset	39 if len(opt) == 5:
40c06bbf58be help: show value requirement and multiple occurrence of options FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 10282 diff changeset	40 shortopt, longopt, default, desc, optlabel = opt
40c06bbf58be help: show value requirement and multiple occurrence of options FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 10282 diff changeset	41 else:
40c06bbf58be help: show value requirement and multiple occurrence of options FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 10282 diff changeset	42 shortopt, longopt, default, desc = opt
20081 93f9d11603d8 doc: show details of command options in pages generated by docutils FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19425 diff changeset	43 optlabel = _("VALUE")
1814 7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	44 allopts = []
7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	45 if shortopt:
7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	46 allopts.append("-%s" % shortopt)
7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	47 if longopt:
7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	48 allopts.append("--%s" % longopt)
20081 93f9d11603d8 doc: show details of command options in pages generated by docutils FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19425 diff changeset	49 if isinstance(default, list):
93f9d11603d8 doc: show details of command options in pages generated by docutils FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19425 diff changeset	50 allopts[-1] += " <%s[+]>" % optlabel
93f9d11603d8 doc: show details of command options in pages generated by docutils FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19425 diff changeset	51 elif (default is not None) and not isinstance(default, bool):
93f9d11603d8 doc: show details of command options in pages generated by docutils FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19425 diff changeset	52 allopts[-1] += " <%s>" % optlabel
20655 37f3be9d1541 doc: gendoc.py creates valid output for option descriptions with newlines Simon Heimberg <simohe@besonet.ch> parents: 20081 diff changeset	53 if '\n' in desc:
37f3be9d1541 doc: gendoc.py creates valid output for option descriptions with newlines Simon Heimberg <simohe@besonet.ch> parents: 20081 diff changeset	54 # only remove line breaks and indentation
37f3be9d1541 doc: gendoc.py creates valid output for option descriptions with newlines Simon Heimberg <simohe@besonet.ch> parents: 20081 diff changeset	55 desc = ' '.join(l.lstrip() for l in desc.split('\n'))
1814 7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	56 desc += default and _(" (default: %s)") % default or ""
13077 6b8d2ee24ce2 coding style: fix yield used as a function Thomas Arendsen Hein <thomas@jtah.de> parents: 12814 diff changeset	57 yield (", ".join(allopts), desc)
1814 7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	58
12756 13f0acfa974a gendoc: refactor get_cmd Erik Zielke <ez@aragost.com> parents: 11570 diff changeset	59 def get_cmd(cmd, cmdtable):
1814 7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	60 d = {}
12756 13f0acfa974a gendoc: refactor get_cmd Erik Zielke <ez@aragost.com> parents: 11570 diff changeset	61 attr = cmdtable[cmd]
1814 7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	62 cmds = cmd.lstrip("^").split("\|")
7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	63
7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	64 d['cmd'] = cmds[0]
7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	65 d['aliases'] = cmd.split("\|")[1:]
19231 814291b5e79c gendoc: make commnd __doc__ and extension __doc__ as translatable Takumi IINO <trot.thunder@gmail.com> parents: 18748 diff changeset	66 d['desc'] = get_desc(gettext(attr[0].__doc__))
1814 7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	67 d['opts'] = list(get_opts(attr[1]))
7376 fc06bd17c985 doc: handle shortened command synopses Matt Mackall <mpm@selenic.com> parents: 7014 diff changeset	68
fc06bd17c985 doc: handle shortened command synopses Matt Mackall <mpm@selenic.com> parents: 7014 diff changeset	69 s = 'hg ' + cmds[0]
fc06bd17c985 doc: handle shortened command synopses Matt Mackall <mpm@selenic.com> parents: 7014 diff changeset	70 if len(attr) > 2:
fc06bd17c985 doc: handle shortened command synopses Matt Mackall <mpm@selenic.com> parents: 7014 diff changeset	71 if not attr[2].startswith('hg'):
8546 a33d19dcf906 gendoc: add missing space in command synopsis Ori Avtalion <ori@avtalion.name> parents: 7376 diff changeset	72 s += ' ' + attr[2]
7376 fc06bd17c985 doc: handle shortened command synopses Matt Mackall <mpm@selenic.com> parents: 7014 diff changeset	73 else:
fc06bd17c985 doc: handle shortened command synopses Matt Mackall <mpm@selenic.com> parents: 7014 diff changeset	74 s = attr[2]
9622 9d1a480ca6ea gendoc: fix synopsis Martin Geisler <mg@lazybytes.net> parents: 9485 diff changeset	75 d['synopsis'] = s.strip()
7376 fc06bd17c985 doc: handle shortened command synopses Matt Mackall <mpm@selenic.com> parents: 7014 diff changeset	76
1814 7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	77 return d
7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	78
19423 5046fede7684 gendoc: rename to showdoc from show_doc Takumi IINO <trot.thunder@gmail.com> parents: 19322 diff changeset	79 def showdoc(ui):
1814 7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	80 # print options
18748 6e676fb6ea44 help: use a full header for topic titles Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17267 diff changeset	81 ui.write(minirst.section(_("Options")))
20081 93f9d11603d8 doc: show details of command options in pages generated by docutils FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19425 diff changeset	82 multioccur = False
1814 7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	83 for optstr, desc in get_opts(globalopts):
12812 4d431a31a76e gendoc: re-add indentation to global option table Martin Geisler <mg@lazybytes.net> parents: 12804 diff changeset	84 ui.write("%s\n %s\n\n" % (optstr, desc))
20081 93f9d11603d8 doc: show details of command options in pages generated by docutils FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19425 diff changeset	85 if optstr.endswith("[+]>"):
93f9d11603d8 doc: show details of command options in pages generated by docutils FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19425 diff changeset	86 multioccur = True
93f9d11603d8 doc: show details of command options in pages generated by docutils FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19425 diff changeset	87 if multioccur:
93f9d11603d8 doc: show details of command options in pages generated by docutils FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19425 diff changeset	88 ui.write(_("\n[+] marked option can be specified multiple times\n"))
93f9d11603d8 doc: show details of command options in pages generated by docutils FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19425 diff changeset	89 ui.write("\n")
1814 7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	90
7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	91 # print cmds
18748 6e676fb6ea44 help: use a full header for topic titles Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17267 diff changeset	92 ui.write(minirst.section(_("Commands")))
6e676fb6ea44 help: use a full header for topic titles Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17267 diff changeset	93 commandprinter(ui, table, minirst.subsection)
12756 13f0acfa974a gendoc: refactor get_cmd Erik Zielke <ez@aragost.com> parents: 11570 diff changeset	94
19233 81d9a7f6f2e7 gendoc: extract print help topics into a dedicated function Takumi IINO <trot.thunder@gmail.com> parents: 19231 diff changeset	95 # print help topics
81d9a7f6f2e7 gendoc: extract print help topics into a dedicated function Takumi IINO <trot.thunder@gmail.com> parents: 19231 diff changeset	96 # The config help topic is included in the hgrc.5 man page.
81d9a7f6f2e7 gendoc: extract print help topics into a dedicated function Takumi IINO <trot.thunder@gmail.com> parents: 19231 diff changeset	97 helpprinter(ui, helptable, minirst.section, exclude=['config'])
12756 13f0acfa974a gendoc: refactor get_cmd Erik Zielke <ez@aragost.com> parents: 11570 diff changeset	98
18748 6e676fb6ea44 help: use a full header for topic titles Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17267 diff changeset	99 ui.write(minirst.section(_("Extensions")))
16683 525fdb738975 cleanup: eradicate long lines Brodie Rao <brodie@sf.io> parents: 14943 diff changeset	100 ui.write(_("This section contains help for extensions that are "
525fdb738975 cleanup: eradicate long lines Brodie Rao <brodie@sf.io> parents: 14943 diff changeset	101 "distributed together with Mercurial. Help for other "
525fdb738975 cleanup: eradicate long lines Brodie Rao <brodie@sf.io> parents: 14943 diff changeset	102 "extensions is available in the help system."))
12781 0d09991f91ee gendoc: automatically create help for default extensions. Erik Zielke <ez@aragost.com> parents: 12780 diff changeset	103 ui.write("\n\n"
0d09991f91ee gendoc: automatically create help for default extensions. Erik Zielke <ez@aragost.com> parents: 12780 diff changeset	104 ".. contents::\n"
0d09991f91ee gendoc: automatically create help for default extensions. Erik Zielke <ez@aragost.com> parents: 12780 diff changeset	105 " :class: htmlonly\n"
0d09991f91ee gendoc: automatically create help for default extensions. Erik Zielke <ez@aragost.com> parents: 12780 diff changeset	106 " :local:\n"
0d09991f91ee gendoc: automatically create help for default extensions. Erik Zielke <ez@aragost.com> parents: 12780 diff changeset	107 " :depth: 1\n\n")
0d09991f91ee gendoc: automatically create help for default extensions. Erik Zielke <ez@aragost.com> parents: 12780 diff changeset	108
0d09991f91ee gendoc: automatically create help for default extensions. Erik Zielke <ez@aragost.com> parents: 12780 diff changeset	109 for extensionname in sorted(allextensionnames()):
0d09991f91ee gendoc: automatically create help for default extensions. Erik Zielke <ez@aragost.com> parents: 12780 diff changeset	110 mod = extensions.load(None, extensionname, None)
18748 6e676fb6ea44 help: use a full header for topic titles Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17267 diff changeset	111 ui.write(minirst.subsection(extensionname))
19231 814291b5e79c gendoc: make commnd __doc__ and extension __doc__ as translatable Takumi IINO <trot.thunder@gmail.com> parents: 18748 diff changeset	112 ui.write("%s\n\n" % gettext(mod.__doc__))
12781 0d09991f91ee gendoc: automatically create help for default extensions. Erik Zielke <ez@aragost.com> parents: 12780 diff changeset	113 cmdtable = getattr(mod, 'cmdtable', None)
0d09991f91ee gendoc: automatically create help for default extensions. Erik Zielke <ez@aragost.com> parents: 12780 diff changeset	114 if cmdtable:
18748 6e676fb6ea44 help: use a full header for topic titles Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17267 diff changeset	115 ui.write(minirst.subsubsection(_('Commands')))
6e676fb6ea44 help: use a full header for topic titles Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17267 diff changeset	116 commandprinter(ui, cmdtable, minirst.subsubsubsection)
12781 0d09991f91ee gendoc: automatically create help for default extensions. Erik Zielke <ez@aragost.com> parents: 12780 diff changeset	117
19424 762e51ce3411 gendoc: add showtopic Takumi IINO <trot.thunder@gmail.com> parents: 19423 diff changeset	118 def showtopic(ui, topic):
762e51ce3411 gendoc: add showtopic Takumi IINO <trot.thunder@gmail.com> parents: 19423 diff changeset	119 extrahelptable = [
762e51ce3411 gendoc: add showtopic Takumi IINO <trot.thunder@gmail.com> parents: 19423 diff changeset	120 (["common"], '', loaddoc('common')),
762e51ce3411 gendoc: add showtopic Takumi IINO <trot.thunder@gmail.com> parents: 19423 diff changeset	121 (["hg.1"], '', loaddoc('hg.1')),
762e51ce3411 gendoc: add showtopic Takumi IINO <trot.thunder@gmail.com> parents: 19423 diff changeset	122 (["hgignore.5"], '', loaddoc('hgignore.5')),
762e51ce3411 gendoc: add showtopic Takumi IINO <trot.thunder@gmail.com> parents: 19423 diff changeset	123 (["hgrc.5"], '', loaddoc('hgrc.5')),
762e51ce3411 gendoc: add showtopic Takumi IINO <trot.thunder@gmail.com> parents: 19423 diff changeset	124 (["hgignore.5.gendoc"], '', loaddoc('hgignore')),
762e51ce3411 gendoc: add showtopic Takumi IINO <trot.thunder@gmail.com> parents: 19423 diff changeset	125 (["hgrc.5.gendoc"], '', loaddoc('config')),
762e51ce3411 gendoc: add showtopic Takumi IINO <trot.thunder@gmail.com> parents: 19423 diff changeset	126 ]
762e51ce3411 gendoc: add showtopic Takumi IINO <trot.thunder@gmail.com> parents: 19423 diff changeset	127 helpprinter(ui, helptable + extrahelptable, None, include=[topic])
762e51ce3411 gendoc: add showtopic Takumi IINO <trot.thunder@gmail.com> parents: 19423 diff changeset	128
19233 81d9a7f6f2e7 gendoc: extract print help topics into a dedicated function Takumi IINO <trot.thunder@gmail.com> parents: 19231 diff changeset	129 def helpprinter(ui, helptable, sectionfunc, include=[], exclude=[]):
81d9a7f6f2e7 gendoc: extract print help topics into a dedicated function Takumi IINO <trot.thunder@gmail.com> parents: 19231 diff changeset	130 for names, sec, doc in helptable:
81d9a7f6f2e7 gendoc: extract print help topics into a dedicated function Takumi IINO <trot.thunder@gmail.com> parents: 19231 diff changeset	131 if exclude and names[0] in exclude:
81d9a7f6f2e7 gendoc: extract print help topics into a dedicated function Takumi IINO <trot.thunder@gmail.com> parents: 19231 diff changeset	132 continue
81d9a7f6f2e7 gendoc: extract print help topics into a dedicated function Takumi IINO <trot.thunder@gmail.com> parents: 19231 diff changeset	133 if include and names[0] not in include:
81d9a7f6f2e7 gendoc: extract print help topics into a dedicated function Takumi IINO <trot.thunder@gmail.com> parents: 19231 diff changeset	134 continue
81d9a7f6f2e7 gendoc: extract print help topics into a dedicated function Takumi IINO <trot.thunder@gmail.com> parents: 19231 diff changeset	135 for name in names:
81d9a7f6f2e7 gendoc: extract print help topics into a dedicated function Takumi IINO <trot.thunder@gmail.com> parents: 19231 diff changeset	136 ui.write(".. _%s:\n" % name)
81d9a7f6f2e7 gendoc: extract print help topics into a dedicated function Takumi IINO <trot.thunder@gmail.com> parents: 19231 diff changeset	137 ui.write("\n")
81d9a7f6f2e7 gendoc: extract print help topics into a dedicated function Takumi IINO <trot.thunder@gmail.com> parents: 19231 diff changeset	138 if sectionfunc:
81d9a7f6f2e7 gendoc: extract print help topics into a dedicated function Takumi IINO <trot.thunder@gmail.com> parents: 19231 diff changeset	139 ui.write(sectionfunc(sec))
81d9a7f6f2e7 gendoc: extract print help topics into a dedicated function Takumi IINO <trot.thunder@gmail.com> parents: 19231 diff changeset	140 if util.safehasattr(doc, '__call__'):
81d9a7f6f2e7 gendoc: extract print help topics into a dedicated function Takumi IINO <trot.thunder@gmail.com> parents: 19231 diff changeset	141 doc = doc()
81d9a7f6f2e7 gendoc: extract print help topics into a dedicated function Takumi IINO <trot.thunder@gmail.com> parents: 19231 diff changeset	142 ui.write(doc)
81d9a7f6f2e7 gendoc: extract print help topics into a dedicated function Takumi IINO <trot.thunder@gmail.com> parents: 19231 diff changeset	143 ui.write("\n")
81d9a7f6f2e7 gendoc: extract print help topics into a dedicated function Takumi IINO <trot.thunder@gmail.com> parents: 19231 diff changeset	144
12781 0d09991f91ee gendoc: automatically create help for default extensions. Erik Zielke <ez@aragost.com> parents: 12780 diff changeset	145 def commandprinter(ui, cmdtable, sectionfunc):
1814 7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	146 h = {}
12756 13f0acfa974a gendoc: refactor get_cmd Erik Zielke <ez@aragost.com> parents: 11570 diff changeset	147 for c, attr in cmdtable.items():
6488 119dff2cd592 gendoc: fix indentation Christian Ebert <blacktrash@gmx.net> parents: 5209 diff changeset	148 f = c.split("\|")[0]
119dff2cd592 gendoc: fix indentation Christian Ebert <blacktrash@gmx.net> parents: 5209 diff changeset	149 f = f.lstrip("^")
119dff2cd592 gendoc: fix indentation Christian Ebert <blacktrash@gmx.net> parents: 5209 diff changeset	150 h[f] = c
1814 7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	151 cmds = h.keys()
7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	152 cmds.sort()
7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	153
7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	154 for f in cmds:
10282 08a0f04b56bd many, many trivial check-code fixups Matt Mackall <mpm@selenic.com> parents: 9792 diff changeset	155 if f.startswith("debug"):
08a0f04b56bd many, many trivial check-code fixups Matt Mackall <mpm@selenic.com> parents: 9792 diff changeset	156 continue
12756 13f0acfa974a gendoc: refactor get_cmd Erik Zielke <ez@aragost.com> parents: 11570 diff changeset	157 d = get_cmd(h[f], cmdtable)
18748 6e676fb6ea44 help: use a full header for topic titles Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17267 diff changeset	158 ui.write(sectionfunc(d['cmd']))
6488 119dff2cd592 gendoc: fix indentation Christian Ebert <blacktrash@gmx.net> parents: 5209 diff changeset	159 # synopsis
12813 13fdef670c43 gendoc: support multi-line synopses Martin Geisler <mg@lazybytes.net> parents: 12812 diff changeset	160 ui.write("::\n\n")
13fdef670c43 gendoc: support multi-line synopses Martin Geisler <mg@lazybytes.net> parents: 12812 diff changeset	161 synopsislines = d['synopsis'].splitlines()
13fdef670c43 gendoc: support multi-line synopses Martin Geisler <mg@lazybytes.net> parents: 12812 diff changeset	162 for line in synopsislines:
13fdef670c43 gendoc: support multi-line synopses Martin Geisler <mg@lazybytes.net> parents: 12812 diff changeset	163 # some commands (such as rebase) have a multi-line
13fdef670c43 gendoc: support multi-line synopses Martin Geisler <mg@lazybytes.net> parents: 12812 diff changeset	164 # synopsis
12814 58bc5024805d gendoc: do not strip 'hg ' from synopsis Martin Geisler <mg@lazybytes.net> parents: 12813 diff changeset	165 ui.write(" %s\n" % line)
12813 13fdef670c43 gendoc: support multi-line synopses Martin Geisler <mg@lazybytes.net> parents: 12812 diff changeset	166 ui.write('\n')
6488 119dff2cd592 gendoc: fix indentation Christian Ebert <blacktrash@gmx.net> parents: 5209 diff changeset	167 # description
119dff2cd592 gendoc: fix indentation Christian Ebert <blacktrash@gmx.net> parents: 5209 diff changeset	168 ui.write("%s\n\n" % d['desc'][1])
119dff2cd592 gendoc: fix indentation Christian Ebert <blacktrash@gmx.net> parents: 5209 diff changeset	169 # options
119dff2cd592 gendoc: fix indentation Christian Ebert <blacktrash@gmx.net> parents: 5209 diff changeset	170 opt_output = list(d['opts'])
119dff2cd592 gendoc: fix indentation Christian Ebert <blacktrash@gmx.net> parents: 5209 diff changeset	171 if opt_output:
119dff2cd592 gendoc: fix indentation Christian Ebert <blacktrash@gmx.net> parents: 5209 diff changeset	172 opts_len = max([len(line[0]) for line in opt_output])
13345 b8214d871338 doc: Capitalize the "options" header of mercurial commands Javi Merino <cibervicho@gmail.com> parents: 13077 diff changeset	173 ui.write(_("Options:\n\n"))
20081 93f9d11603d8 doc: show details of command options in pages generated by docutils FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19425 diff changeset	174 multioccur = False
6488 119dff2cd592 gendoc: fix indentation Christian Ebert <blacktrash@gmx.net> parents: 5209 diff changeset	175 for optstr, desc in opt_output:
119dff2cd592 gendoc: fix indentation Christian Ebert <blacktrash@gmx.net> parents: 5209 diff changeset	176 if desc:
119dff2cd592 gendoc: fix indentation Christian Ebert <blacktrash@gmx.net> parents: 5209 diff changeset	177 s = "%-*s %s" % (opts_len, optstr, desc)
119dff2cd592 gendoc: fix indentation Christian Ebert <blacktrash@gmx.net> parents: 5209 diff changeset	178 else:
119dff2cd592 gendoc: fix indentation Christian Ebert <blacktrash@gmx.net> parents: 5209 diff changeset	179 s = optstr
12780 bdc1cf692447 gendoc: dedent documentation from docstrings Erik Zielke <ez@aragost.com> parents: 12777 diff changeset	180 ui.write("%s\n" % s)
20081 93f9d11603d8 doc: show details of command options in pages generated by docutils FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19425 diff changeset	181 if optstr.endswith("[+]>"):
93f9d11603d8 doc: show details of command options in pages generated by docutils FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19425 diff changeset	182 multioccur = True
93f9d11603d8 doc: show details of command options in pages generated by docutils FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19425 diff changeset	183 if multioccur:
93f9d11603d8 doc: show details of command options in pages generated by docutils FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19425 diff changeset	184 ui.write(_("\n[+] marked option can be specified"
93f9d11603d8 doc: show details of command options in pages generated by docutils FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 19425 diff changeset	185 " multiple times\n"))
6488 119dff2cd592 gendoc: fix indentation Christian Ebert <blacktrash@gmx.net> parents: 5209 diff changeset	186 ui.write("\n")
119dff2cd592 gendoc: fix indentation Christian Ebert <blacktrash@gmx.net> parents: 5209 diff changeset	187 # aliases
119dff2cd592 gendoc: fix indentation Christian Ebert <blacktrash@gmx.net> parents: 5209 diff changeset	188 if d['aliases']:
119dff2cd592 gendoc: fix indentation Christian Ebert <blacktrash@gmx.net> parents: 5209 diff changeset	189 ui.write(_(" aliases: %s\n\n") % " ".join(d['aliases']))
1814 7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	190
3797 54fd4d3b4fce Generate docs for help topics Matt Mackall <mpm@selenic.com> parents: 1814 diff changeset	191
12781 0d09991f91ee gendoc: automatically create help for default extensions. Erik Zielke <ez@aragost.com> parents: 12780 diff changeset	192 def allextensionnames():
14316 d5b525697ddb extensions: drop maxlength from enabled and disabled Matt Mackall <mpm@selenic.com> parents: 13345 diff changeset	193 return extensions.enabled().keys() + extensions.disabled().keys()
12781 0d09991f91ee gendoc: automatically create help for default extensions. Erik Zielke <ez@aragost.com> parents: 12780 diff changeset	194
1814 7956893e8458 generate hg manpage from commands.py docstring Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: diff changeset	195 if __name__ == "__main__":
19425 81fbd4e66ff5 gendoc: dispatch print document content by commandline arguments Takumi IINO <trot.thunder@gmail.com> parents: 19424 diff changeset	196 doc = 'hg.1.gendoc'
81fbd4e66ff5 gendoc: dispatch print document content by commandline arguments Takumi IINO <trot.thunder@gmail.com> parents: 19424 diff changeset	197 if len(sys.argv) > 1:
81fbd4e66ff5 gendoc: dispatch print document content by commandline arguments Takumi IINO <trot.thunder@gmail.com> parents: 19424 diff changeset	198 doc = sys.argv[1]
81fbd4e66ff5 gendoc: dispatch print document content by commandline arguments Takumi IINO <trot.thunder@gmail.com> parents: 19424 diff changeset	199
81fbd4e66ff5 gendoc: dispatch print document content by commandline arguments Takumi IINO <trot.thunder@gmail.com> parents: 19424 diff changeset	200 if doc == 'hg.1.gendoc':
81fbd4e66ff5 gendoc: dispatch print document content by commandline arguments Takumi IINO <trot.thunder@gmail.com> parents: 19424 diff changeset	201 showdoc(sys.stdout)
81fbd4e66ff5 gendoc: dispatch print document content by commandline arguments Takumi IINO <trot.thunder@gmail.com> parents: 19424 diff changeset	202 else:
81fbd4e66ff5 gendoc: dispatch print document content by commandline arguments Takumi IINO <trot.thunder@gmail.com> parents: 19424 diff changeset	203 showtopic(sys.stdout, sys.argv[1])

Mercurial > public > mercurial-scm > hg-stable

annotate doc/gendoc.py @ 20655:37f3be9d1541