Permalink
Browse files

Add titles to table of contents

  • Loading branch information...
bdarnell committed Jun 11, 2011
1 parent 0747607 commit 8fd9413f40be6c4f2c10653654a64e48629f4662
View
@@ -1,5 +1,5 @@
-``tornado.auth``
-======================
+``tornado.auth`` --- Third-party login with OpenID and OAuth
+============================================================
.. automodule:: tornado.auth
:members:
@@ -1,5 +1,5 @@
-``tornado.autoreload``
-======================
+``tornado.autoreload`` --- Automatically detect code changes in development
+===========================================================================
.. automodule:: tornado.autoreload
:members:
@@ -1,5 +1,5 @@
-``tornado.database``
-======================
+``tornado.database`` --- Simple MySQL client wrapper
+====================================================
.. automodule:: tornado.database
:members:
@@ -1,5 +1,5 @@
-``tornado.escape``
-======================
+``tornado.escape`` --- Escaping and string manipulation
+=======================================================
.. automodule:: tornado.escape
:members:
@@ -1,5 +1,5 @@
-``tornado.httpclient``
-======================
+``tornado.httpclient`` --- Non-blocking HTTP client
+===================================================
.. automodule:: tornado.httpclient
:members:
@@ -1,5 +1,5 @@
-``tornado.httpserver``
-======================
+``tornado.httpserver`` --- Non-blocking HTTP server
+===================================================
.. automodule:: tornado.httpserver
:members:
@@ -1,5 +1,5 @@
-``tornado.httputil``
-======================
+``tornado.httputil`` --- Manipulate HTTP headers and URLs
+=========================================================
.. automodule:: tornado.httputil
:members:
View
@@ -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
@@ -1,5 +1,5 @@
-``tornado.ioloop``
-======================
+``tornado.ioloop`` --- Main event loop
+======================================
.. automodule:: tornado.ioloop
:members:
@@ -1,5 +1,5 @@
-``tornado.iostream``
-======================
+``tornado.iostream`` --- Convenient wrappers for non-blocking sockets
+=====================================================================
.. automodule:: tornado.iostream
:members:
@@ -1,5 +1,5 @@
-``tornado.locale``
-======================
+``tornado.locale`` --- Internationalization support
+===================================================
.. automodule:: tornado.locale
:members:
@@ -1,5 +1,5 @@
-``tornado.options``
-======================
+``tornado.options`` --- Command-line parsing
+============================================
.. automodule:: tornado.options
:members:
@@ -1,5 +1,5 @@
-``tornado.stack_context``
-=========================
+``tornado.stack_context`` --- Exception handling across asynchronous callbacks
+==============================================================================
.. automodule:: tornado.stack_context
:members:
@@ -1,5 +1,5 @@
-``tornado.template``
-======================
+``tornado.template`` --- Flexible output generation
+===================================================
.. automodule:: tornado.template
:members:
@@ -1,5 +1,5 @@
-``tornado.testing``
-======================
+``tornado.testing`` --- Unit testing support for asynchronous code
+==================================================================
.. automodule:: tornado.testing
:members:
View
@@ -1,5 +1,5 @@
-``tornado.web``
-===============
+``tornado.web`` --- ``RequestHandler`` and ``Application`` classes
+==================================================================
.. automodule:: tornado.web
@@ -2,6 +2,7 @@ Core web framework
==================
.. toctree::
+ :maxdepth: 2
web
httpserver
@@ -1,5 +1,5 @@
-``tornado.websocket``
-======================
+``tornado.websocket`` --- Bidirectional communication to the browser
+====================================================================
.. automodule:: tornado.websocket
:members:
View
@@ -1,5 +1,5 @@
-``tornado.wsgi``
-======================
+``tornado.wsgi`` --- Interoperability with other Python frameworks and servers
+==============================================================================
.. automodule:: tornado.wsgi
:members:

0 comments on commit 8fd9413

Please sign in to comment.