##// END OF EJS Templates
doc: unify section level between help topics...
doc: unify section level between help topics 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.

File last commit:

r16350:4f795f5f stable
r17267:979b107e stable
Show More
test-gendoc.t
57 lines | 1.6 KiB | text/troff | Tads3Lexer
Test document extraction
$ "$TESTDIR/hghave" docutils || exit 80
$ HGENCODING=UTF-8
$ export HGENCODING
$ { echo C; find "$TESTDIR/../i18n" -name "*.po" | sort; } | while read PO; do
> LOCALE=`basename "$PO" .po`
> echo
> echo "% extracting documentation from $LOCALE"
> echo ".. -*- coding: utf-8 -*-" > gendoc-$LOCALE.txt
> echo "" >> gendoc-$LOCALE.txt
> LC_ALL=$LOCALE python "$TESTDIR/../doc/gendoc.py" >> gendoc-$LOCALE.txt 2> /dev/null || exit
>
> # We call runrst without adding "--halt warning" to make it report
> # all errors instead of stopping on the first one.
> echo "checking for parse errors"
> python "$TESTDIR/../doc/runrst" html gendoc-$LOCALE.txt /dev/null
> done
% extracting documentation from C
checking for parse errors
% extracting documentation from da
checking for parse errors
% extracting documentation from de
checking for parse errors
% extracting documentation from el
checking for parse errors
% extracting documentation from fr
checking for parse errors
% extracting documentation from it
checking for parse errors
% extracting documentation from ja
checking for parse errors
% extracting documentation from pt_BR
checking for parse errors
% extracting documentation from ro
checking for parse errors
% extracting documentation from ru
checking for parse errors
% extracting documentation from sv
checking for parse errors
% extracting documentation from zh_CN
checking for parse errors
% extracting documentation from zh_TW
checking for parse errors