mirror of
https://github.com/facebook/sapling.git
synced 2024-10-07 23:38:50 +03:00
807a8f6caa
This patch adds "doc/check-seclevel.py" which checks below in help documents: - whether unknown or unavailable section marks are used or not - whether appropriate section mark is used at sub-sectioning It should be invoked in "doc" directory. It checks all help documents of Mercurial (topics, commands, extensions), if no file is specified by --file option. With --file option, it checks contents of the specified file as help document, for self testing purpose: -t/-c/-e/-C are used to specify what kind of help document contents of the specified file is. This checking is related to changeset 8d980034517b. |
||
|---|---|---|
| .. | ||
| check-seclevel.py | ||
| common.txt | ||
| gendoc.py | ||
| hg.1.txt | ||
| hgignore.5.txt | ||
| hgmanpage.py | ||
| hgrc.5.txt | ||
| Makefile | ||
| README | ||
| runrst | ||
| style.css | ||
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.