Skeletal autogenerated reference documentation

bdarnell · bdarnell · commit 4fec6aeb98f0 · 2011-06-08T23:58:58.000-07:00
diff --git a/website/Makefile b/website/Makefile
@@ -0,0 +1,6 @@
+.PHONY: sphinx
+sphinx:
+	sphinx-build -b html -d sphinx/build/doctrees sphinx sphinx/build/html
+
+clean:
+	rm -rf sphinx/build
diff --git a/website/sphinx/auth.rst b/website/sphinx/auth.rst
@@ -0,0 +1,4 @@
+``tornado.auth``
+======================
+
+.. automodule:: tornado.auth
diff --git a/website/sphinx/autoreload.rst b/website/sphinx/autoreload.rst
@@ -0,0 +1,4 @@
+``tornado.autoreload``
+======================
+
+.. automodule:: tornado.autoreload
diff --git a/website/sphinx/conf.py b/website/sphinx/conf.py
@@ -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"]
diff --git a/website/sphinx/database.rst b/website/sphinx/database.rst
@@ -0,0 +1,4 @@
+``tornado.database``
+======================
+
+.. automodule:: tornado.database
diff --git a/website/sphinx/escape.rst b/website/sphinx/escape.rst
@@ -0,0 +1,4 @@
+``tornado.escape``
+======================
+
+.. automodule:: tornado.escape
diff --git a/website/sphinx/httpclient.rst b/website/sphinx/httpclient.rst
@@ -0,0 +1,4 @@
+``tornado.httpclient``
+======================
+
+.. automodule:: tornado.httpclient
diff --git a/website/sphinx/httpserver.rst b/website/sphinx/httpserver.rst
@@ -0,0 +1,4 @@
+``tornado.httpserver``
+======================
+
+.. automodule:: tornado.httpserver
diff --git a/website/sphinx/httputil.rst b/website/sphinx/httputil.rst
@@ -0,0 +1,4 @@
+``tornado.httputil``
+======================
+
+.. automodule:: tornado.httputil
diff --git a/website/sphinx/index.rst b/website/sphinx/index.rst
@@ -0,0 +1,21 @@
+Tornado API Reference
+=====================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   webframework
+   networking
+   integration
+   utilities
+   
+   
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/website/sphinx/integration.rst b/website/sphinx/integration.rst
@@ -0,0 +1,9 @@
+Integration with other services
+===============================
+
+.. toctree::
+
+   auth
+   database
+   websocket
+   wsgi
diff --git a/website/sphinx/ioloop.rst b/website/sphinx/ioloop.rst
@@ -0,0 +1,4 @@
+``tornado.ioloop``
+======================
+
+.. automodule:: tornado.ioloop
diff --git a/website/sphinx/iostream.rst b/website/sphinx/iostream.rst
@@ -0,0 +1,4 @@
+``tornado.iostream``
+======================
+
+.. automodule:: tornado.iostream
diff --git a/website/sphinx/locale.rst b/website/sphinx/locale.rst
@@ -0,0 +1,4 @@
+``tornado.locale``
+======================
+
+.. automodule:: tornado.locale
diff --git a/website/sphinx/networking.rst b/website/sphinx/networking.rst
@@ -0,0 +1,8 @@
+Asynchronous networking
+=======================
+
+.. toctree::
+
+   ioloop
+   iostream
+   httpclient
diff --git a/website/sphinx/options.rst b/website/sphinx/options.rst
@@ -0,0 +1,4 @@
+``tornado.options``
+======================
+
+.. automodule:: tornado.options
diff --git a/website/sphinx/stack_context.rst b/website/sphinx/stack_context.rst
@@ -0,0 +1,4 @@
+``tornado.stack_context``
+=========================
+
+.. automodule:: tornado.stack_context
diff --git a/website/sphinx/template.rst b/website/sphinx/template.rst
@@ -0,0 +1,4 @@
+``tornado.template``
+======================
+
+.. automodule:: tornado.template
diff --git a/website/sphinx/testing.rst b/website/sphinx/testing.rst
@@ -0,0 +1,4 @@
+``tornado.testing``
+======================
+
+.. automodule:: tornado.testing
diff --git a/website/sphinx/utilities.rst b/website/sphinx/utilities.rst
@@ -0,0 +1,11 @@
+Utilities
+=========
+
+.. toctree::
+
+   autoreload
+   httputil
+   options
+   stack_context
+   testing
+   
diff --git a/website/sphinx/web.rst b/website/sphinx/web.rst
@@ -0,0 +1,4 @@
+``tornado.web``
+===============
+
+.. automodule:: tornado.web
diff --git a/website/sphinx/webframework.rst b/website/sphinx/webframework.rst
@@ -0,0 +1,10 @@
+Core web framework
+==================
+
+.. toctree::
+
+   web
+   httpserver
+   template
+   escape
+   locale
diff --git a/website/sphinx/websocket.rst b/website/sphinx/websocket.rst
@@ -0,0 +1,4 @@
+``tornado.websocket``
+======================
+
+.. automodule:: tornado.websocket
diff --git a/website/sphinx/wsgi.rst b/website/sphinx/wsgi.rst
@@ -0,0 +1,4 @@
+``tornado.wsgi``
+======================
+
+.. automodule:: tornado.wsgi
