[cfe-commits] r171417 - /cfe/trunk/docs/index.rst

[Sean Silva]

Author: silvas
Date: Wed Jan  2 15:50:48 2013
New Revision: 171417

URL: http://llvm.org/viewvc/llvm-project?rev=171417&view=rev
Log:
docs: Take advantage of extra level of headings.

The way Sphinx treats the "top-level" adornments is weird. It usually
uses the first top-level adornment as the page title, even if the
top-level adornment is just one "section" out of many (i.e. if the first
section is "Introduction", then it will make the page title be
"Introduction"). This behavior can be overriden by using an explicit
`..  title::` directive to set the title.

Since the Sphinx stylesheet that Clang is currently using ('haiku')
nicely puts the document title at the top of the page in the header,
this weird default behavior was resulting in a redundant "title" in the
body content. Getting rid of this redundant level of headings
effectively "exposes" one more level of heading from the stylesheet to
which now makes the real "sections" more distinct.

Modified:
    cfe/trunk/docs/index.rst

Modified: cfe/trunk/docs/index.rst
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/docs/index.rst?rev=171417&r1=171416&r2=171417&view=diff
==============================================================================
--- cfe/trunk/docs/index.rst (original)
+++ cfe/trunk/docs/index.rst Wed Jan  2 15:50:48 2013
@@ -3,8 +3,7 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to Clang's documentation!
-=================================
+.. title:: Welcome to Clang's documentation!
 
 .. toctree::
    :maxdepth: 1
@@ -12,7 +11,7 @@
    ReleaseNotes
 
 Using Clang as a Compiler
--------------------------
+=========================
 
 .. toctree::
    :maxdepth: 1
@@ -24,7 +23,7 @@
    MemorySanitizer
 
 Using Clang as a Library
-------------------------
+========================
 
 .. toctree::
    :maxdepth: 1
@@ -41,7 +40,7 @@
    JSONCompilationDatabase
 
 Design Documents
-----------------
+================
 
 .. toctree::
    :maxdepth: 1