sapling/doc
Mads Kiilerich 2cd7eecc00 doc/Makefile: detect the right name for rst2man and rst2html
docutils uses the .py extension on the commands, and so do their installer.
Distribution packages might strip the .py, but the official name should work too.
2009-08-20 23:35:46 +02:00
..
ja change wiki/bts URLs to point to new hostname 2009-06-24 15:32:37 +02:00
common.txt doc: link man pages to one another 2009-07-16 23:25:26 +02:00
gendoc.py Backed out changeset e07e58e3faab (depends on other changes, no tests) 2009-08-05 16:32:38 +02:00
hg.1.txt doc: link man pages to one another 2009-07-16 23:25:26 +02:00
hgignore.5.txt hgignore.5: mark file names and cmdline options as literal text 2009-07-21 12:19:53 +02:00
hgrc.5.txt Merge with crew-stable 2009-08-22 10:52:53 +02:00
Makefile doc/Makefile: detect the right name for rst2man and rst2html 2009-08-20 23:35:46 +02:00
README doc: update README with links to Docutils 2009-07-18 22:28:28 +02:00

Mercurial's documentation is kept in reStructuredText format, which is
a simple plain text format that's easy to read and edit:

  http://docutils.sourceforge.net/rst.html

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 the rst2html and rst2man tools,
which are part of Docutils:

  http://docutils.sourceforge.net/

The rst2man tool is still in their so-called "sandbox". The above page
has links to tarballs of both Docutils and their sandbox.

Use the Makefile in this directory to generate the man and HTML pages.