Mercurial > hg
annotate doc/README @ 20081:93f9d11603d8
doc: show details of command options in pages generated by docutils
Before this patch, HTML/man pages generated by docutils don't show
details of each command options, whether it should take argument or
not for example, even though "hg help" does.
This patch shows details of command options as same as "hg help"
shows.
This patch uses "--option <VALUE[+]>" style instead of "--option
<VALUE> [+]" used in output of "hg help", because docutils requires
that option argument strings starts with "<" and ends with ">".
author | FUJIWARA Katsunori <foozy@lares.dti.ne.jp> |
---|---|
date | Fri, 08 Nov 2013 14:42:09 +0900 |
parents | 3516a4e877c1 |
children |
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 | 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 |
9419
3516a4e877c1
doc/README: simplify instructions
Martin Geisler <mg@lazybytes.net>
parents:
9406
diff
changeset
|
7 UNIX man page format and HTML. You'll need to install Docutils: |
177 | 8 |
9172
bc1de09090bc
doc: update README with links to Docutils
Martin Geisler <mg@lazybytes.net>
parents:
5048
diff
changeset
|
9 http://docutils.sourceforge.net/ |
177 | 10 |
9172
bc1de09090bc
doc: update README with links to Docutils
Martin Geisler <mg@lazybytes.net>
parents:
5048
diff
changeset
|
11 Use the Makefile in this directory to generate the man and HTML pages. |