facebook/sapling
1
1
Fork 0
mirror of https://github.com/facebook/sapling.git synced 2024-10-09 00:14:35 +03:00
Code Issues Projects Releases Wiki Activity
fdca8c570d
sapling/doc
History
FUJIWARA Katsunori 8c1c74a873 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 ">".
2013-11-08 14:42:09 +09:00
..
check-seclevel.py doc: add the tool to check section marks in help documents 2012-08-13 21:25:48 +09:00
gendoc.py doc: show details of command options in pages generated by docutils 2013-11-08 14:42:09 +09:00
hgmanpage.py cleanup: drop unused variables and an unused import 2013-07-01 20:48:56 +02:00
Makefile doc: make i18n man and html 2013-07-03 21:50:20 +09:00
README doc/README: simplify instructions 2009-09-03 21:40:45 +02:00
runrst runrst: improve error message when Docutils is missing 2011-10-20 17:47:33 +02:00
style.css codingstyle: remove trailing spaces in various text files 2013-04-17 03:40:18 +02:00

README 

Mercurial's documentation is kept in reStructuredText format, which is
a simple plain text format that's easy to read and edit:

  http://docutils.sourceforge.net/rst.html

It's also convertible to a variety of other formats including standard
UNIX man page format and HTML. You'll need to install Docutils:

  http://docutils.sourceforge.net/

Use the Makefile in this directory to generate the man and HTML pages.