mirror of
https://github.com/facebook/sapling.git
synced 2024-10-11 09:17:30 +03:00
0cf97588a4
Some help topics use "-" for the top level underlining section mark, but "-" is used also for the top level categorization in generated documents: "hg.1.html", for example. So, TOC in such documents contain "sections in each topics", too. This patch changes underlining section mark in some help topics to unify section level in generated documents. After this patching, levels of each section marks are: level0 """""" level1 ====== level2 ------ level3 ...... level4 ###### And use of section markers in each documents are: - mercurial/help/*.txt can use level1 or more (now these use level1 and level2) - help for core commands can use level2 or more (now these use no section marker) - descriptions of extensions can use level2 or more (now hgext/acl uses level2) - help for commands defined in extension can use level4 or more (now "convert" of hgext/convert uses level4) "Level0" is used as top level categorization only in "doc/hg.1.txt" and the intermediate file generated by "doc/gendoc.py", so end users don't see it in "hg help" outoput and so on. |
||
---|---|---|
.. | ||
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.