From 8fd9413f40be6c4f2c10653654a64e48629f4662 Mon Sep 17 00:00:00 2001 From: Ben Darnell Date: Sat, 11 Jun 2011 14:48:46 -0700 Subject: [PATCH] Add titles to table of contents --- website/sphinx/auth.rst | 4 ++-- website/sphinx/autoreload.rst | 4 ++-- website/sphinx/database.rst | 4 ++-- website/sphinx/escape.rst | 4 ++-- website/sphinx/httpclient.rst | 4 ++-- website/sphinx/httpserver.rst | 4 ++-- website/sphinx/httputil.rst | 4 ++-- website/sphinx/index.rst | 5 ++++- website/sphinx/ioloop.rst | 4 ++-- website/sphinx/iostream.rst | 4 ++-- website/sphinx/locale.rst | 4 ++-- website/sphinx/options.rst | 4 ++-- website/sphinx/stack_context.rst | 4 ++-- website/sphinx/template.rst | 4 ++-- website/sphinx/testing.rst | 4 ++-- website/sphinx/web.rst | 4 ++-- website/sphinx/webframework.rst | 1 + website/sphinx/websocket.rst | 4 ++-- website/sphinx/wsgi.rst | 4 ++-- 19 files changed, 39 insertions(+), 35 deletions(-) diff --git a/website/sphinx/auth.rst b/website/sphinx/auth.rst index b0f9ebf874..46065945c9 100644 --- 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 01ab31483c..4e1c9871f1 100644 --- 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 7a7dc8153c..f6debdc9c1 100644 --- 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 d67ec5898d..6a434f3f1a 100644 --- 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 4022a63f83..b1f28009cc 100644 --- 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 11e5c3efbc..41f7e1d33a 100644 --- 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 8041775945..4befc65525 100644 --- 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 23f26d3adb..98cf1afe57 100644 --- 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 `_ document is also +available. .. toctree:: :maxdepth: 2 diff --git a/website/sphinx/ioloop.rst b/website/sphinx/ioloop.rst index 03f9072c08..1c23171c9c 100644 --- 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 e65ca27ecc..28de480b32 100644 --- 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 41b8bf2745..57fdca54b0 100644 --- 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 c6a3e10a63..a201bc2c8a 100644 --- 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 95a14f8102..489a37fdc5 100644 --- 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 d9d549403d..11c2ea574b 100644 --- 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 65caf01616..9378d927cf 100644 --- 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 5f03700739..5ea2927b41 100644 --- 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 d1dab0ca29..cf0935361b 100644 --- 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 6c064feef6..c4bd0ed5a5 100644 --- 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 37876b8788..489e85d9b3 100644 --- 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: