Mercurial > hg-stable
changeset 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 | a458b9bf4f3a |
| children | cf7c6acb890e |
| files | doc/README |
| diffstat | 1 files changed, 11 insertions(+), 17 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/README Fri Jul 17 20:52:21 2009 +0200 +++ b/doc/README Sat Jul 18 22:28:28 2009 +0200 @@ -1,23 +1,17 @@ -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. +Mercurial's documentation is kept in reStructuredText format, which is +a simple plain text format that's easy to read and edit: -To do this, you'll need to install ASCIIDOC: + http://docutils.sourceforge.net/rst.html - http://www.methods.co.nz/asciidoc/ - -To generate the man page: +It's also convertible to a variety of other formats including standard +UNIX man page format and HTML. - asciidoc -d manpage -b docbook hg.1.txt - xmlto man hg.1.xml +To do this, you'll need to install the rst2html and rst2man tools, +which are part of Docutils: -To display: + http://docutils.sourceforge.net/ - groff -mandoc -Tascii hg.1 | more - -To create the html page (without stylesheets): +The rst2man tool is still in their so-called "sandbox". The above page +has links to tarballs of both Docutils and their sandbox. - asciidoc -b html4 hg.1.txt - -(older asciidoc may want html instead of html4 above) +Use the Makefile in this directory to generate the man and HTML pages.