Skeletal autogenerated reference documentation
This commit is contained in:
parent
b92e70d07c
commit
4fec6aeb98
|
@ -0,0 +1,6 @@
|
|||
.PHONY: sphinx
|
||||
sphinx:
|
||||
sphinx-build -b html -d sphinx/build/doctrees sphinx sphinx/build/html
|
||||
|
||||
clean:
|
||||
rm -rf sphinx/build
|
|
@ -0,0 +1,4 @@
|
|||
``tornado.auth``
|
||||
======================
|
||||
|
||||
.. automodule:: tornado.auth
|
|
@ -0,0 +1,4 @@
|
|||
``tornado.autoreload``
|
||||
======================
|
||||
|
||||
.. automodule:: tornado.autoreload
|
|
@ -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"]
|
|
@ -0,0 +1,4 @@
|
|||
``tornado.database``
|
||||
======================
|
||||
|
||||
.. automodule:: tornado.database
|
|
@ -0,0 +1,4 @@
|
|||
``tornado.escape``
|
||||
======================
|
||||
|
||||
.. automodule:: tornado.escape
|
|
@ -0,0 +1,4 @@
|
|||
``tornado.httpclient``
|
||||
======================
|
||||
|
||||
.. automodule:: tornado.httpclient
|
|
@ -0,0 +1,4 @@
|
|||
``tornado.httpserver``
|
||||
======================
|
||||
|
||||
.. automodule:: tornado.httpserver
|
|
@ -0,0 +1,4 @@
|
|||
``tornado.httputil``
|
||||
======================
|
||||
|
||||
.. automodule:: tornado.httputil
|
|
@ -0,0 +1,21 @@
|
|||
Tornado API Reference
|
||||
=====================
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
webframework
|
||||
networking
|
||||
integration
|
||||
utilities
|
||||
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
|
@ -0,0 +1,9 @@
|
|||
Integration with other services
|
||||
===============================
|
||||
|
||||
.. toctree::
|
||||
|
||||
auth
|
||||
database
|
||||
websocket
|
||||
wsgi
|
|
@ -0,0 +1,4 @@
|
|||
``tornado.ioloop``
|
||||
======================
|
||||
|
||||
.. automodule:: tornado.ioloop
|
|
@ -0,0 +1,4 @@
|
|||
``tornado.iostream``
|
||||
======================
|
||||
|
||||
.. automodule:: tornado.iostream
|
|
@ -0,0 +1,4 @@
|
|||
``tornado.locale``
|
||||
======================
|
||||
|
||||
.. automodule:: tornado.locale
|
|
@ -0,0 +1,8 @@
|
|||
Asynchronous networking
|
||||
=======================
|
||||
|
||||
.. toctree::
|
||||
|
||||
ioloop
|
||||
iostream
|
||||
httpclient
|
|
@ -0,0 +1,4 @@
|
|||
``tornado.options``
|
||||
======================
|
||||
|
||||
.. automodule:: tornado.options
|
|
@ -0,0 +1,4 @@
|
|||
``tornado.stack_context``
|
||||
=========================
|
||||
|
||||
.. automodule:: tornado.stack_context
|
|
@ -0,0 +1,4 @@
|
|||
``tornado.template``
|
||||
======================
|
||||
|
||||
.. automodule:: tornado.template
|
|
@ -0,0 +1,4 @@
|
|||
``tornado.testing``
|
||||
======================
|
||||
|
||||
.. automodule:: tornado.testing
|
|
@ -0,0 +1,11 @@
|
|||
Utilities
|
||||
=========
|
||||
|
||||
.. toctree::
|
||||
|
||||
autoreload
|
||||
httputil
|
||||
options
|
||||
stack_context
|
||||
testing
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
``tornado.web``
|
||||
===============
|
||||
|
||||
.. automodule:: tornado.web
|
|
@ -0,0 +1,10 @@
|
|||
Core web framework
|
||||
==================
|
||||
|
||||
.. toctree::
|
||||
|
||||
web
|
||||
httpserver
|
||||
template
|
||||
escape
|
||||
locale
|
|
@ -0,0 +1,4 @@
|
|||
``tornado.websocket``
|
||||
======================
|
||||
|
||||
.. automodule:: tornado.websocket
|
|
@ -0,0 +1,4 @@
|
|||
``tornado.wsgi``
|
||||
======================
|
||||
|
||||
.. automodule:: tornado.wsgi
|
Loading…
Reference in New Issue