From 4fec6aeb98f002d834649654e168e1ae382afcd5 Mon Sep 17 00:00:00 2001 From: Ben Darnell Date: Wed, 8 Jun 2011 23:58:58 -0700 Subject: [PATCH] Skeletal autogenerated reference documentation --- website/Makefile | 6 ++++++ website/sphinx/auth.rst | 4 ++++ website/sphinx/autoreload.rst | 4 ++++ website/sphinx/conf.py | 20 ++++++++++++++++++++ website/sphinx/database.rst | 4 ++++ website/sphinx/escape.rst | 4 ++++ website/sphinx/httpclient.rst | 4 ++++ website/sphinx/httpserver.rst | 4 ++++ website/sphinx/httputil.rst | 4 ++++ website/sphinx/index.rst | 21 +++++++++++++++++++++ website/sphinx/integration.rst | 9 +++++++++ website/sphinx/ioloop.rst | 4 ++++ website/sphinx/iostream.rst | 4 ++++ website/sphinx/locale.rst | 4 ++++ website/sphinx/networking.rst | 8 ++++++++ website/sphinx/options.rst | 4 ++++ website/sphinx/stack_context.rst | 4 ++++ website/sphinx/template.rst | 4 ++++ website/sphinx/testing.rst | 4 ++++ website/sphinx/utilities.rst | 11 +++++++++++ website/sphinx/web.rst | 4 ++++ website/sphinx/webframework.rst | 10 ++++++++++ website/sphinx/websocket.rst | 4 ++++ website/sphinx/wsgi.rst | 4 ++++ 24 files changed, 153 insertions(+) create mode 100644 website/Makefile create mode 100644 website/sphinx/auth.rst create mode 100644 website/sphinx/autoreload.rst create mode 100644 website/sphinx/conf.py create mode 100644 website/sphinx/database.rst create mode 100644 website/sphinx/escape.rst create mode 100644 website/sphinx/httpclient.rst create mode 100644 website/sphinx/httpserver.rst create mode 100644 website/sphinx/httputil.rst create mode 100644 website/sphinx/index.rst create mode 100644 website/sphinx/integration.rst create mode 100644 website/sphinx/ioloop.rst create mode 100644 website/sphinx/iostream.rst create mode 100644 website/sphinx/locale.rst create mode 100644 website/sphinx/networking.rst create mode 100644 website/sphinx/options.rst create mode 100644 website/sphinx/stack_context.rst create mode 100644 website/sphinx/template.rst create mode 100644 website/sphinx/testing.rst create mode 100644 website/sphinx/utilities.rst create mode 100644 website/sphinx/web.rst create mode 100644 website/sphinx/webframework.rst create mode 100644 website/sphinx/websocket.rst create mode 100644 website/sphinx/wsgi.rst diff --git a/website/Makefile b/website/Makefile new file mode 100644 index 00000000..45215cff --- /dev/null +++ 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 \ No newline at end of file diff --git a/website/sphinx/auth.rst b/website/sphinx/auth.rst new file mode 100644 index 00000000..f05fca6f --- /dev/null +++ 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 new file mode 100644 index 00000000..cedb3960 --- /dev/null +++ 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 new file mode 100644 index 00000000..53addb17 --- /dev/null +++ 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 new file mode 100644 index 00000000..5ba77c09 --- /dev/null +++ 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 new file mode 100644 index 00000000..0c35cf05 --- /dev/null +++ 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 new file mode 100644 index 00000000..14eb643f --- /dev/null +++ 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 new file mode 100644 index 00000000..85c2b1a0 --- /dev/null +++ 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 new file mode 100644 index 00000000..7cfef497 --- /dev/null +++ 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 new file mode 100644 index 00000000..23f26d3a --- /dev/null +++ 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 new file mode 100644 index 00000000..bf0f1314 --- /dev/null +++ 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 new file mode 100644 index 00000000..2cf69d98 --- /dev/null +++ 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 new file mode 100644 index 00000000..e43671a3 --- /dev/null +++ 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 new file mode 100644 index 00000000..cb7ce77c --- /dev/null +++ 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 new file mode 100644 index 00000000..e77622dc --- /dev/null +++ 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 new file mode 100644 index 00000000..a6ce5a57 --- /dev/null +++ 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 new file mode 100644 index 00000000..36a7de3e --- /dev/null +++ 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 new file mode 100644 index 00000000..34a8a4b0 --- /dev/null +++ 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 new file mode 100644 index 00000000..a01d1431 --- /dev/null +++ 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 new file mode 100644 index 00000000..89c99080 --- /dev/null +++ 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 new file mode 100644 index 00000000..be5eec91 --- /dev/null +++ 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 new file mode 100644 index 00000000..d1dab0ca --- /dev/null +++ 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 new file mode 100644 index 00000000..f09078d6 --- /dev/null +++ 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 new file mode 100644 index 00000000..b893340a --- /dev/null +++ b/website/sphinx/wsgi.rst @@ -0,0 +1,4 @@ +``tornado.wsgi`` +====================== + +.. automodule:: tornado.wsgi