Mercurial > hg

annotate doc/README @ 9406:a4b761751919

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc/README: rst2man is now in Docutils proper
author Martin Geisler <mg@lazybytes.net>
date Fri, 28 Aug 2009 20:28:06 +0200
parents bc1de09090bc
children 3516a4e877c1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
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
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
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
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
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
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
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
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
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
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
13
9406
a4b761751919 doc/README: rst2man is now in Docutils proper
Martin Geisler <mg@lazybytes.net>
parents: 9172
diff changeset
14 The rst2man tool is not yet in a stable Docutils release, you have to
a4b761751919 doc/README: rst2man is now in Docutils proper
Martin Geisler <mg@lazybytes.net>
parents: 9172
diff changeset
15 install their snapshot, which is what they recommend you run anyway:
a4b761751919 doc/README: rst2man is now in Docutils proper
Martin Geisler <mg@lazybytes.net>
parents: 9172
diff changeset
16
a4b761751919 doc/README: rst2man is now in Docutils proper
Martin Geisler <mg@lazybytes.net>
parents: 9172
diff changeset
17 http://docutils.sourceforge.net/docutils-snapshot.tgz
177
91055f795d88 adding doc directory and files
jake@edge2.net
parents:
diff changeset
18
9172
bc1de09090bc doc: update README with links to Docutils
Martin Geisler <mg@lazybytes.net>
parents: 5048
diff changeset
19 Use the Makefile in this directory to generate the man and HTML pages.