Mercurial > hg
comparison doc/README @ 9172:bc1de09090bc
doc: update README with links to Docutils
author | Martin Geisler <mg@lazybytes.net> |
---|---|
date | Sat, 18 Jul 2009 22:28:28 +0200 |
parents | 8db8e1100f3f |
children | a4b761751919 |
comparison
equal
deleted
inserted
replaced
9171:a458b9bf4f3a | 9172:bc1de09090bc |
---|---|
1 Mercurial's documentation is currently kept in ASCIIDOC format, which | 1 Mercurial's documentation is kept in reStructuredText format, which is |
2 is a simple plain text format that's easy to read and edit. It's also | 2 a simple plain text format that's easy to read and edit: |
3 convertible to a variety of other formats including standard UNIX man | |
4 page format and HTML. | |
5 | 3 |
6 To do this, you'll need to install ASCIIDOC: | 4 http://docutils.sourceforge.net/rst.html |
7 | 5 |
8 http://www.methods.co.nz/asciidoc/ | 6 It's also convertible to a variety of other formats including standard |
7 UNIX man page format and HTML. | |
9 | 8 |
10 To generate the man page: | 9 To do this, you'll need to install the rst2html and rst2man tools, |
10 which are part of Docutils: | |
11 | 11 |
12 asciidoc -d manpage -b docbook hg.1.txt | 12 http://docutils.sourceforge.net/ |
13 xmlto man hg.1.xml | |
14 | 13 |
15 To display: | 14 The rst2man tool is still in their so-called "sandbox". The above page |
15 has links to tarballs of both Docutils and their sandbox. | |
16 | 16 |
17 groff -mandoc -Tascii hg.1 | more | 17 Use the Makefile in this directory to generate the man and HTML pages. |
18 | |
19 To create the html page (without stylesheets): | |
20 | |
21 asciidoc -b html4 hg.1.txt | |
22 | |
23 (older asciidoc may want html instead of html4 above) |