##// END OF EJS Templates
upstream » mercurial-mirror
RSS

Clone from https://www.mercurial-scm.org/repo/hg-all

doc: use reStructuredText for man and HTML pages...
doc: use reStructuredText for man and HTML pages The Makefile now requires the rst2html and rst2man programs. Both can be found in Debian testing or downloaded from the Docutils homepage: http://docutils.sf.net/ http://docutils.sf.net/sandbox/manpage-writer/ The new HTML and man pages no longer contain huge amounts of un-wrapping literal blocks, thanks to how snippets of reStructuredText can easily be included inside other reStructuredText documents. The HTML pages now have anchors for all sections, including the help topics in hgrc.1 which were missing from the old HTML pages.
Martin Geisler -
r9158:d6eecafa default
Show More
Name Size Modified Last Commit Author
/ doc
ja
Makefile Loading ...
README Loading ...
gendoc.py Loading ...
hg.1.txt Loading ...
hgignore.5.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 html4 hg.1.txt

(older asciidoc may want html instead of html4 above)