diff doc/gendoc.py @ 17267:979b107eaea2 stable

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.

--- a/doc/gendoc.py	Mon Jul 23 19:03:32 2012 +0200
+++ b/doc/gendoc.py	Wed Jul 25 16:40:38 2012 +0900
@@ -64,16 +64,16 @@
     return d
 
 def section(ui, s):
-    ui.write("%s\n%s\n\n" % (s, "-" * encoding.colwidth(s)))
+    ui.write("%s\n%s\n\n" % (s, "\"" * encoding.colwidth(s)))
 
 def subsection(ui, s):
-    ui.write("%s\n%s\n\n" % (s, '"' * encoding.colwidth(s)))
+    ui.write("%s\n%s\n\n" % (s, '=' * encoding.colwidth(s)))
 
 def subsubsection(ui, s):
-    ui.write("%s\n%s\n\n" % (s, "." * encoding.colwidth(s)))
+    ui.write("%s\n%s\n\n" % (s, "-" * encoding.colwidth(s)))
 
 def subsubsubsection(ui, s):
-    ui.write("%s\n%s\n\n" % (s, "#" * encoding.colwidth(s)))
+    ui.write("%s\n%s\n\n" % (s, "." * encoding.colwidth(s)))
 
 
 def show_doc(ui):