Skeletal autogenerated reference documentation

This commit is contained in:
Ben Darnell 2011-06-08 23:58:58 -07:00
parent b92e70d07c
commit 4fec6aeb98
24 changed files with 153 additions and 0 deletions

6
website/Makefile Normal file
View File

@ -0,0 +1,6 @@
.PHONY: sphinx
sphinx:
sphinx-build -b html -d sphinx/build/doctrees sphinx sphinx/build/html
clean:
rm -rf sphinx/build

4
website/sphinx/auth.rst Normal file
View File

@ -0,0 +1,4 @@
``tornado.auth``
======================
.. automodule:: tornado.auth

View File

@ -0,0 +1,4 @@
``tornado.autoreload``
======================
.. automodule:: tornado.autoreload

20
website/sphinx/conf.py Normal file
View File

@ -0,0 +1,20 @@
# Ensure we get the local copy of tornado instead of what's on the standard path
import os
import sys
sys.path.insert(0, os.path.abspath("../.."))
import tornado
print tornado.__file__
master_doc = "index"
project = "Tornado"
copyright = "2011, Facebook"
import tornado
version = release = tornado.version
extensions = ["sphinx.ext.autodoc"]
autodoc_member_order = "bysource"
autodoc_default_flags = ["members", "undoc-members"]

View File

@ -0,0 +1,4 @@
``tornado.database``
======================
.. automodule:: tornado.database

View File

@ -0,0 +1,4 @@
``tornado.escape``
======================
.. automodule:: tornado.escape

View File

@ -0,0 +1,4 @@
``tornado.httpclient``
======================
.. automodule:: tornado.httpclient

View File

@ -0,0 +1,4 @@
``tornado.httpserver``
======================
.. automodule:: tornado.httpserver

View File

@ -0,0 +1,4 @@
``tornado.httputil``
======================
.. automodule:: tornado.httputil

21
website/sphinx/index.rst Normal file
View File

@ -0,0 +1,21 @@
Tornado API Reference
=====================
Contents:
.. toctree::
:maxdepth: 2
webframework
networking
integration
utilities
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

View File

@ -0,0 +1,9 @@
Integration with other services
===============================
.. toctree::
auth
database
websocket
wsgi

View File

@ -0,0 +1,4 @@
``tornado.ioloop``
======================
.. automodule:: tornado.ioloop

View File

@ -0,0 +1,4 @@
``tornado.iostream``
======================
.. automodule:: tornado.iostream

View File

@ -0,0 +1,4 @@
``tornado.locale``
======================
.. automodule:: tornado.locale

View File

@ -0,0 +1,8 @@
Asynchronous networking
=======================
.. toctree::
ioloop
iostream
httpclient

View File

@ -0,0 +1,4 @@
``tornado.options``
======================
.. automodule:: tornado.options

View File

@ -0,0 +1,4 @@
``tornado.stack_context``
=========================
.. automodule:: tornado.stack_context

View File

@ -0,0 +1,4 @@
``tornado.template``
======================
.. automodule:: tornado.template

View File

@ -0,0 +1,4 @@
``tornado.testing``
======================
.. automodule:: tornado.testing

View File

@ -0,0 +1,11 @@
Utilities
=========
.. toctree::
autoreload
httputil
options
stack_context
testing

4
website/sphinx/web.rst Normal file
View File

@ -0,0 +1,4 @@
``tornado.web``
===============
.. automodule:: tornado.web

View File

@ -0,0 +1,10 @@
Core web framework
==================
.. toctree::
web
httpserver
template
escape
locale

View File

@ -0,0 +1,4 @@
``tornado.websocket``
======================
.. automodule:: tornado.websocket

4
website/sphinx/wsgi.rst Normal file
View File

@ -0,0 +1,4 @@
``tornado.wsgi``
======================
.. automodule:: tornado.wsgi