##// END OF EJS Templates
generate hg manpage from commands.py docstring...
generate hg manpage from commands.py docstring gendoc.py is a script generating a part of the manpage (the commands help and options) from the docstring in commands.py. It avoids duplicating the doc between the doc/ directory and the docstrings. To generate the manpage, 'make doc' will create all the necessary intermediate files.
Benoit Boissinot -
r1814:7956893e default
Show More
Name Size Modified Last Commit Author
/ doc
ja
Makefile Loading ...
README Loading ...
gendoc.py Loading ...
hg.1.txt Loading ...
hgmerge.1.txt Loading ...
hgrc.5.txt Loading ...

Mercurial's documentation is currently kept in ASCIIDOC format, which
is a simple plain text format that's easy to read and edit. It's also
convertible to a variety of other formats including standard UNIX man
page format and HTML.

To do this, you'll need to install ASCIIDOC:

http://www.methods.co.nz/asciidoc/

To generate the man page:

asciidoc -d manpage -b docbook hg.1.txt
xmlto man hg.1.xml

To display:

groff -mandoc -Tascii hg.1 | more

To create the html page (without stylesheets):

asciidoc -b html hg.1.txt