Add titles to table of contents

diff --git a/website/sphinx/auth.rst b/website/sphinx/auth.rst
index b0f9ebf874ceb654b454511f892a4a79b08270b4..46065945c918090857b9a8fd5e63d5b8bc075bb1 100644 (file)
--- 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
index 01ab31483c55a92b84914eb5043414f4bab849dc..4e1c9871f1f61025fa49cb9b70cec8209006dcc9 100644 (file)
--- 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
index 7a7dc8153c74f2d2740b1b6c75b6c2eae0fd70a6..f6debdc9c163f538bdf34f4a82baefe5703c2564 100644 (file)
--- 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
index d67ec5898d30ae6b1e3438636940e726521f85de..6a434f3f1aa98802c618f9405db779c8913b24cd 100644 (file)
--- 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
index 4022a63f83d83ee10f5f3ce31417e8b2a61e1e0e..b1f28009cca7169521bdc575f688beb6f6c1506b 100644 (file)
--- 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
index 11e5c3efbc29df2a4aea48c509f74c3b606356fd..41f7e1d33a9b000e6785951568ec4fe28a8314a8 100644 (file)
--- 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
index 80417759455b0690b0634f2c5f73a23d2720909c..4befc65525fb2892688a8e7cdce868187ac704f9 100644 (file)
--- 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
index 23f26d3adb2de66677bcee62739994469da6a41e..98cf1afe57a8f1f53f2c50d8c471eadfc2ff16fa 100644 (file)
--- 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
index 03f9072c08937f1be79860935d8284fa6d9b67a6..1c23171c9ccb172e807a4a2379722cf066d8cf6d 100644 (file)
--- 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
index e65ca27eccdbb7498cc1e51b18ea7465f6263e43..28de480b32cae07e246c77bd3a426a8d4cbdfdeb 100644 (file)
--- 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
index 41b8bf274569491de44afed51e70750835347049..57fdca54b0d5249bdbff281bde576e57342059e5 100644 (file)
--- 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
index c6a3e10a634ee2914993aa472f43cab1ac920dd5..a201bc2c8a432c54044fd700e783c6a91fc61a74 100644 (file)
--- 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
index 95a14f8102b14dc8c6bb585199fe22a73937e147..489a37fdc59e14fd2a9d99150079eb1ac67c2c85 100644 (file)
--- 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
index d9d549403d3e2f0c044d4f4324a85785b6cebf20..11c2ea574b186fe8b904367e0c642b303f69af4a 100644 (file)
--- 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
index 65caf01616a8811998dc744c34ceca2fd128c9f3..9378d927cfcd1f9e5cedbef009bbd8c8a847286c 100644 (file)
--- 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
index 5f037007396094eaff12a01c1608284bbe403a99..5ea2927b41d84578c873ddb847daf219bbfe5604 100644 (file)
--- 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
index d1dab0ca2905159f09cf4f4e938fc45fdb2ed9cb..cf0935361b6a7bc58dd5df27828072f5aac2c92b 100644 (file)
--- 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
index 6c064feef63ae46a1d42d39713daabae7314f5b7..c4bd0ed5a5db4215fac848c4e1d9a2dea32fa855 100644 (file)
--- 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
index 37876b8788e8942b48265357bf92a716faf996d1..489e85d9b32f2a980f9b51789f53b47be7687dc0 100644 (file)
--- 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: