Add titles to table of contents

tornadoweb · Jun 11, 2011 · 8fd9413 · 8fd9413
1 parent 0747607
commit 8fd9413
Show file tree

Hide file tree

Showing 19 changed files with 39 additions and 35 deletions.
diff --git a/website/sphinx/auth.rst b/website/sphinx/auth.rst
@@ -1,5 +1,5 @@
-``tornado.auth``
-======================
+``tornado.auth`` --- Third-party login with OpenID and OAuth
+============================================================
 
 .. automodule:: tornado.auth
    :members:
diff --git a/website/sphinx/autoreload.rst b/website/sphinx/autoreload.rst
@@ -1,5 +1,5 @@
-``tornado.autoreload``
-======================
+``tornado.autoreload`` --- Automatically detect code changes in development
+===========================================================================
 
 .. automodule:: tornado.autoreload
    :members:
diff --git a/website/sphinx/database.rst b/website/sphinx/database.rst
@@ -1,5 +1,5 @@
-``tornado.database``
-======================
+``tornado.database`` --- Simple MySQL client wrapper
+====================================================
 
 .. automodule:: tornado.database
    :members:
diff --git a/website/sphinx/escape.rst b/website/sphinx/escape.rst
@@ -1,5 +1,5 @@
-``tornado.escape``
-======================
+``tornado.escape`` --- Escaping and string manipulation
+=======================================================
 
 .. automodule:: tornado.escape
    :members:
diff --git a/website/sphinx/httpclient.rst b/website/sphinx/httpclient.rst
@@ -1,5 +1,5 @@
-``tornado.httpclient``
-======================
+``tornado.httpclient`` --- Non-blocking HTTP client
+===================================================
 
 .. automodule:: tornado.httpclient
    :members:
diff --git a/website/sphinx/httpserver.rst b/website/sphinx/httpserver.rst
@@ -1,5 +1,5 @@
-``tornado.httpserver``
-======================
+``tornado.httpserver`` --- Non-blocking HTTP server
+===================================================
 
 .. automodule:: tornado.httpserver
    :members:
diff --git a/website/sphinx/httputil.rst b/website/sphinx/httputil.rst
@@ -1,5 +1,5 @@
-``tornado.httputil``
-======================
+``tornado.httputil`` --- Manipulate HTTP headers and URLs
+=========================================================
 
 .. automodule:: tornado.httputil
    :members:
diff --git a/website/sphinx/index.rst b/website/sphinx/index.rst
@@ -1,7 +1,10 @@
 Tornado API Reference
 =====================
 
-Contents:
+The following documents are automatically generated from docstrings
+in the source code.  A separate 
+`overview <http://tornadoweb.org/documentation/overview>`_ document is also 
+available.
 
 .. toctree::
    :maxdepth: 2

diff --git a/website/sphinx/ioloop.rst b/website/sphinx/ioloop.rst
@@ -1,5 +1,5 @@
-``tornado.ioloop``
-======================
+``tornado.ioloop`` --- Main event loop
+======================================
 
 .. automodule:: tornado.ioloop
    :members:
diff --git a/website/sphinx/iostream.rst b/website/sphinx/iostream.rst
@@ -1,5 +1,5 @@
-``tornado.iostream``
-======================
+``tornado.iostream`` --- Convenient wrappers for non-blocking sockets
+=====================================================================
 
 .. automodule:: tornado.iostream
    :members:
diff --git a/website/sphinx/locale.rst b/website/sphinx/locale.rst
@@ -1,5 +1,5 @@
-``tornado.locale``
-======================
+``tornado.locale`` --- Internationalization support
+===================================================
 
 .. automodule:: tornado.locale
    :members:
diff --git a/website/sphinx/options.rst b/website/sphinx/options.rst
@@ -1,5 +1,5 @@
-``tornado.options``
-======================
+``tornado.options`` --- Command-line parsing
+============================================
 
 .. automodule:: tornado.options
    :members:
diff --git a/website/sphinx/stack_context.rst b/website/sphinx/stack_context.rst
@@ -1,5 +1,5 @@
-``tornado.stack_context``
-=========================
+``tornado.stack_context`` --- Exception handling across asynchronous callbacks
+==============================================================================
 
 .. automodule:: tornado.stack_context
    :members:
diff --git a/website/sphinx/template.rst b/website/sphinx/template.rst
@@ -1,5 +1,5 @@
-``tornado.template``
-======================
+``tornado.template`` --- Flexible output generation
+===================================================
 
 .. automodule:: tornado.template
    :members:
diff --git a/website/sphinx/testing.rst b/website/sphinx/testing.rst
@@ -1,5 +1,5 @@
-``tornado.testing``
-======================
+``tornado.testing`` --- Unit testing support for asynchronous code
+==================================================================
 
 .. automodule:: tornado.testing
    :members:
diff --git a/website/sphinx/web.rst b/website/sphinx/web.rst
@@ -1,5 +1,5 @@
-``tornado.web``
-===============
+``tornado.web`` --- ``RequestHandler`` and ``Application`` classes
+==================================================================
 
 .. automodule:: tornado.web
 

diff --git a/website/sphinx/webframework.rst b/website/sphinx/webframework.rst
@@ -2,6 +2,7 @@ Core web framework
 ==================
 
 .. toctree::
+   :maxdepth: 2
 
    web
    httpserver

diff --git a/website/sphinx/websocket.rst b/website/sphinx/websocket.rst
@@ -1,5 +1,5 @@
-``tornado.websocket``
-======================
+``tornado.websocket`` --- Bidirectional communication to the browser
+====================================================================
 
 .. automodule:: tornado.websocket
    :members:
diff --git a/website/sphinx/wsgi.rst b/website/sphinx/wsgi.rst
@@ -1,5 +1,5 @@
-``tornado.wsgi``
-======================
+``tornado.wsgi`` --- Interoperability with other Python frameworks and servers
+==============================================================================
 
 .. automodule:: tornado.wsgi
    :members: