author | Martin Geisler <mg@lazybytes.net> |
Sat, 22 Aug 2009 10:52:53 +0200 | |
changeset 9381 | 642febca0e5d |
parent 9172 | bc1de09090bc |
child 9406 | a4b761751919 |
permissions | -rw-r--r-- |
9172
bc1de09090bc
doc: update README with links to Docutils
Martin Geisler <mg@lazybytes.net>
parents:
5048
diff
changeset
|
1 |
Mercurial's documentation is kept in reStructuredText format, which is |
bc1de09090bc
doc: update README with links to Docutils
Martin Geisler <mg@lazybytes.net>
parents:
5048
diff
changeset
|
2 |
a simple plain text format that's easy to read and edit: |
177 | 3 |
|
9172
bc1de09090bc
doc: update README with links to Docutils
Martin Geisler <mg@lazybytes.net>
parents:
5048
diff
changeset
|
4 |
http://docutils.sourceforge.net/rst.html |
177 | 5 |
|
9172
bc1de09090bc
doc: update README with links to Docutils
Martin Geisler <mg@lazybytes.net>
parents:
5048
diff
changeset
|
6 |
It's also convertible to a variety of other formats including standard |
bc1de09090bc
doc: update README with links to Docutils
Martin Geisler <mg@lazybytes.net>
parents:
5048
diff
changeset
|
7 |
UNIX man page format and HTML. |
177 | 8 |
|
9172
bc1de09090bc
doc: update README with links to Docutils
Martin Geisler <mg@lazybytes.net>
parents:
5048
diff
changeset
|
9 |
To do this, you'll need to install the rst2html and rst2man tools, |
bc1de09090bc
doc: update README with links to Docutils
Martin Geisler <mg@lazybytes.net>
parents:
5048
diff
changeset
|
10 |
which are part of Docutils: |
177 | 11 |
|
9172
bc1de09090bc
doc: update README with links to Docutils
Martin Geisler <mg@lazybytes.net>
parents:
5048
diff
changeset
|
12 |
http://docutils.sourceforge.net/ |
177 | 13 |
|
9172
bc1de09090bc
doc: update README with links to Docutils
Martin Geisler <mg@lazybytes.net>
parents:
5048
diff
changeset
|
14 |
The rst2man tool is still in their so-called "sandbox". The above page |
bc1de09090bc
doc: update README with links to Docutils
Martin Geisler <mg@lazybytes.net>
parents:
5048
diff
changeset
|
15 |
has links to tarballs of both Docutils and their sandbox. |
177 | 16 |
|
9172
bc1de09090bc
doc: update README with links to Docutils
Martin Geisler <mg@lazybytes.net>
parents:
5048
diff
changeset
|
17 |
Use the Makefile in this directory to generate the man and HTML pages. |