Skip to content

Commit 5ec2ab0

Browse files
committed
Remove some redundant sections; flatten document structure
1 parent 3907686 commit 5ec2ab0

File tree

3 files changed

+6
-141
lines changed

3 files changed

+6
-141
lines changed

website/sphinx/index.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,6 @@
11
Tornado API Reference
22
=====================
33

4-
The following documents are automatically generated from docstrings
5-
in the source code. A separate
6-
`overview <http://tornadoweb.org/documentation/overview>`_ document is also
7-
available.
8-
94
.. toctree::
105
:maxdepth: 2
116

website/sphinx/overview.rst

Lines changed: 4 additions & 136 deletions
Original file line numberDiff line numberDiff line change
@@ -48,138 +48,6 @@ We attempted to clean up the code base to reduce interdependencies
4848
between modules, so you should (theoretically) be able to use any of the
4949
modules independently in your project without using the whole package.
5050

51-
Download and install
52-
--------------------
53-
54-
.. raw:: html
55-
56-
<p>
57-
58-
Automatic installation: Tornado is listed in PyPI and can be installed
59-
with pip or easy\_install. If you do not already have libcurl installed
60-
you may need to install it separately; see the prerequisites section
61-
below. Note that the source distribution includes demo applications that
62-
are not present when Tornado is installed using pip or easy\_install
63-
64-
.. raw:: html
65-
66-
</p>
67-
68-
.. raw:: html
69-
70-
<p>
71-
72-
Manual installation: Download tornado-1.2.1.tar.gz
73-
74-
.. raw:: html
75-
76-
</p>
77-
<pre><code>tar xvzf tornado-1.2.1.tar.gz
78-
cd tornado-1.2.1
79-
python setup.py build
80-
sudo python setup.py install</code></pre>
81-
<p>
82-
83-
The Tornado source code is hosted on GitHub. On Python 2.6+, it is also
84-
possible to simply add the tornado directory to your PYTHONPATH instead
85-
of building with setup.py, since the standard library includes epoll
86-
support.
87-
88-
.. raw:: html
89-
90-
</p>
91-
92-
.. raw:: html
93-
94-
<h3>
95-
96-
Prerequisites
97-
98-
.. raw:: html
99-
100-
</h3>
101-
<p>
102-
103-
Tornado has been tested on Python 2.5, 2.6, and 2.7. To use all of the
104-
features of Tornado, you need to have PycURL (version 7.18.2 or higher)
105-
and (for Python 2.5 only) simplejson installed (Python 2.6 includes JSON
106-
support in the standard library so simplejson is not needed). Complete
107-
installation instructions for Mac OS X and Ubuntu are included below for
108-
convenience.
109-
110-
.. raw:: html
111-
112-
</p>
113-
<p style="font-weight:bold">
114-
115-
Mac OS X 10.6 (Python 2.6+)
116-
117-
.. raw:: html
118-
119-
</p>
120-
<pre><code>sudo easy_install setuptools pycurl</code></pre>
121-
122-
.. raw:: html
123-
124-
<p style="font-weight:bold">
125-
126-
Ubuntu Linux (Python 2.6+)
127-
128-
.. raw:: html
129-
130-
</p>
131-
<pre><code>sudo apt-get install python-pycurl</code></pre>
132-
133-
.. raw:: html
134-
135-
<p style="font-weight:bold">
136-
137-
Ubuntu Linux (Python 2.5)
138-
139-
.. raw:: html
140-
141-
</p>
142-
<pre><code>sudo apt-get install python-dev python-pycurl python-simplejson</code></pre>
143-
144-
Module index
145-
------------
146-
147-
The most important module is `tornado.web`
148-
which is the web framework that includes most of the meat of the Tornado
149-
package. The other modules are tools that make `tornado.web` more useful. See
150-
`Tornado walkthrough <#tornado-walkthrough>`_ below for a detailed
151-
walkthrough of the `~tornado.web` package.
152-
153-
Main modules
154-
~~~~~~~~~~~~
155-
156-
- `tornado.web` - The web framework on which FriendFeed is built. `web`
157-
incorporates most of the important features of Tornado
158-
- `tornado.escape` - XHTML, JSON, and URL encoding/decoding methods
159-
- `tornado.database` - A simple wrapper around ``MySQLdb`` to make MySQL
160-
easier to use
161-
- `tornado.template` - A Python-based web templating language
162-
- `tornado.httpclient` - A non-blocking HTTP client designed to work
163-
with ``web`` and ``httpserver``
164-
- `tornado.auth` - Implementation of third party authentication and
165-
authorization schemes (Google OpenID/OAuth, Facebook Platform, Yahoo BBAuth,
166-
FriendFeed OpenID/OAuth, Twitter OAuth)
167-
- `tornado.locale` - Localization/translation support
168-
- `tornado.options` - Command line and config file parsing, optimized for
169-
server environments
170-
171-
Low-level modules
172-
~~~~~~~~~~~~~~~~~
173-
174-
- `tornado.httpserver` - A very simple HTTP server built on which ``web`` is
175-
built
176-
- `tornado.iostream` - A simple wrapper around non-blocking sockets to aide
177-
common reading and writing patterns
178-
- `tornado.ioloop` - Core I/O loop
179-
180-
Tornado walkthrough
181-
-------------------
182-
18351
Request handlers and request arguments
18452
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18553

@@ -1061,7 +929,7 @@ standalone module in ``tornado.autoreload``, and is optionally used by
1061929
the test runner in ``tornado.testing.main``.
1062930

1063931
Performance
1064-
-----------
932+
~~~~~~~~~~~
1065933

1066934
Web application performance is generally bound by architecture, not
1067935
frontend performance. That said, Tornado is pretty fast relative to most
@@ -1108,7 +976,7 @@ shouldn't add too much latency to your apps relative to most Python web
1108976
development frameworks.
1109977

1110978
Running Tornado in production
1111-
-----------------------------
979+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1112980

1113981
At FriendFeed, we use `nginx <http://nginx.net/>`_ as a load balancer
1114982
and static file server. We run multiple instances of the Tornado web
@@ -1201,7 +1069,7 @@ running on ports 8000 - 8003:
12011069
}
12021070

12031071
WSGI and Google AppEngine
1204-
-------------------------
1072+
~~~~~~~~~~~~~~~~~~~~~~~~~
12051073

12061074
Tornado comes with limited support for `WSGI <http://wsgi.org/>`_.
12071075
However, since WSGI does not support non-blocking requests, you cannot
@@ -1237,7 +1105,7 @@ See the ``appengine`` example application for a full-featured AppEngine
12371105
app built on Tornado.
12381106

12391107
Caveats and support
1240-
-------------------
1108+
~~~~~~~~~~~~~~~~~~~
12411109

12421110
Because FriendFeed and other large users of Tornado run `behind
12431111
nginx <#running-tornado-in-production>`_ or Apache proxies, Tornado's

website/static/sphinx.css

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ div.related {
4646
div.body {
4747
top: 30px;
4848
bottom: 0;
49+
right: 0;
50+
left: 230px;
4951
margin: 0;
5052
position: fixed;
5153
overflow: auto;

0 commit comments

Comments
 (0)