summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJon Nelson <jnelson@jamponi.net>2009-07-06 19:30:49 -0500
committerJon Nelson <jnelson@jamponi.net>2009-07-06 19:30:49 -0500
commit36bd8bfa631b302aa3ae2d73aafadd260ecb55e9 (patch)
treedf790f191b2ae4d91097b05a764f5d834b50d11e
parentc519c0d97251fb56ef4a5c9b2e35290f754b79e9 (diff)
downloadflup-36bd8bfa631b302aa3ae2d73aafadd260ecb55e9.tar.gz
split out the docs somewhat
-rw-r--r--docs/source/index.rst159
-rw-r--r--docs/source/modules/flup.server.ajp.rst8
-rw-r--r--docs/source/modules/flup.server.ajp_base.rst7
-rw-r--r--docs/source/modules/flup.server.ajp_fork.rst7
-rw-r--r--docs/source/modules/flup.server.cgi.rst7
-rw-r--r--docs/source/modules/flup.server.fcgi.rst7
-rw-r--r--docs/source/modules/flup.server.fcgi_base.rst7
-rw-r--r--docs/source/modules/flup.server.fcgi_fork.rst7
-rw-r--r--docs/source/modules/flup.server.fcgi_single.rst7
-rw-r--r--docs/source/modules/flup.server.paste_factory.rst8
-rw-r--r--docs/source/modules/flup.server.preforkserver.rst9
-rw-r--r--docs/source/modules/flup.server.scgi.rst7
-rw-r--r--docs/source/modules/flup.server.scgi_base.rst7
-rw-r--r--docs/source/modules/flup.server.scgi_fork.rst7
-rw-r--r--docs/source/modules/flup.server.singleserver.rst9
-rw-r--r--docs/source/modules/flup.server.threadedserver.rst9
-rw-r--r--docs/source/modules/flup.server.threadpool.rst8
17 files changed, 139 insertions, 141 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 5e2b67e..4607992 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -1,8 +1,3 @@
-.. flup documentation master file, created by
- sphinx-quickstart on Mon Jul 6 10:53:43 2009.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
-
Welcome to flup's documentation!
================================
@@ -11,144 +6,26 @@ Contents:
.. toctree::
:maxdepth: 2
-Modules
-=======
-
-.. automodule:: flup.server
- :members:
- :undoc-members:
- :inherited-members:
-
-flup.server.ajp
----------------
-
-.. automodule:: flup.server.ajp
- :members:
- :undoc-members:
- :inherited-members:
-
-flup.server.ajp_base
---------------------
-
-.. automodule:: flup.server.ajp_base
- :members:
- :undoc-members:
- :inherited-members:
-
-flup.server.ajp_fork
---------------------
-
-.. automodule:: flup.server.ajp_fork
- :members:
- :undoc-members:
- :inherited-members:
-
-flup.server.cgi
----------------
-
-.. automodule:: flup.server.cgi
- :members:
- :undoc-members:
- :inherited-members:
-
-flup.server.fcgi
-----------------
-
-.. automodule:: flup.server.fcgi
- :members:
- :undoc-members:
- :inherited-members:
-
-flup.server.fcgi_base
----------------------
-
-.. automodule:: flup.server.fcgi_base
- :members:
- :undoc-members:
- :inherited-members:
-
-
-flup.server.fcgi_fork
----------------------
-
-.. automodule:: flup.server.fcgi_fork
- :members:
- :undoc-members:
- :inherited-members:
-
-flup.server.fcgi_single
------------------------
+ modules/flup.server.ajp_base
+ modules/flup.server.ajp
+ modules/flup.server.ajp_fork
+ modules/flup.server.cgi
+ modules/flup.server.fcgi_base
+ modules/flup.server.fcgi
+ modules/flup.server.fcgi_fork
+ modules/flup.server.fcgi_single
+ modules/flup.server.scgi_base
+ modules/flup.server.scgi
+ modules/flup.server.scgi_fork
+ modules/flup.server.paste_factory
+ modules/flup.server.threadedserver
+ modules/flup.server.threadpool
+ modules/flup.server.preforkserver
+ modules/flup.server.singleserver
-.. automodule:: flup.server.fcgi_single
- :members:
- :undoc-members:
- :inherited-members:
-flup.server.scgi
-----------------
-
-.. automodule:: flup.server.scgi
- :members:
- :undoc-members:
- :inherited-members:
-
-flup.server.scgi_base
----------------------
-
-.. automodule:: flup.server.scgi_base
- :members:
- :undoc-members:
- :inherited-members:
-
-flup.server.scgi_fork
----------------------
-
-.. automodule:: flup.server.scgi_fork
- :members:
- :undoc-members:
- :inherited-members:
-
-flup.server.paste_factory
--------------------------
-
-.. automodule:: flup.server.paste_factory
- :members:
- :undoc-members:
- :inherited-members:
-
-flup.server.threadpool
-----------------------
-
-.. automodule:: flup.server.threadpool
- :members:
- :undoc-members:
- :inherited-members:
-
-
-flup.server.threadedserver
---------------------------
-
-.. automodule:: flup.server.threadedserver
- :members:
- :undoc-members:
- :inherited-members:
-
-
-flup.server.preforkserver
--------------------------
-
-.. automodule:: flup.server.preforkserver
- :members:
- :undoc-members:
- :inherited-members:
-
-flup.server.singleserver
-------------------------
-
-.. automodule:: flup.server.singleserver
- :members:
- :undoc-members:
- :inherited-members:
+Modules
+=======
Indices and tables
diff --git a/docs/source/modules/flup.server.ajp.rst b/docs/source/modules/flup.server.ajp.rst
new file mode 100644
index 0000000..412bc56
--- /dev/null
+++ b/docs/source/modules/flup.server.ajp.rst
@@ -0,0 +1,8 @@
+:mod:`flup.server.ajp` - ajp - an AJP 1.3/WSGI gateway (threaded)
+=================================================================
+
+.. automodule:: flup.server.ajp
+ :members:
+ :undoc-members:
+ :inherited-members:
+
diff --git a/docs/source/modules/flup.server.ajp_base.rst b/docs/source/modules/flup.server.ajp_base.rst
new file mode 100644
index 0000000..0c06181
--- /dev/null
+++ b/docs/source/modules/flup.server.ajp_base.rst
@@ -0,0 +1,7 @@
+:mod:`flup.server.ajp_base` - ajp - an AJP 1.3/WSGI gateway
+===========================================================
+
+.. automodule:: flup.server.ajp_base
+ :members:
+ :undoc-members:
+ :inherited-members:
diff --git a/docs/source/modules/flup.server.ajp_fork.rst b/docs/source/modules/flup.server.ajp_fork.rst
new file mode 100644
index 0000000..220b609
--- /dev/null
+++ b/docs/source/modules/flup.server.ajp_fork.rst
@@ -0,0 +1,7 @@
+:mod:`flup.server.ajp_fork` - ajp - an AJP 1.3/WSGI gateway (forking)
+=====================================================================
+
+.. automodule:: flup.server.ajp_fork
+ :members:
+ :undoc-members:
+ :inherited-members:
diff --git a/docs/source/modules/flup.server.cgi.rst b/docs/source/modules/flup.server.cgi.rst
new file mode 100644
index 0000000..316da0b
--- /dev/null
+++ b/docs/source/modules/flup.server.cgi.rst
@@ -0,0 +1,7 @@
+:mod:`flup.server.cgi`
+======================
+
+.. automodule:: flup.server.cgi
+ :members:
+ :undoc-members:
+ :inherited-members:
diff --git a/docs/source/modules/flup.server.fcgi.rst b/docs/source/modules/flup.server.fcgi.rst
new file mode 100644
index 0000000..9e8ede7
--- /dev/null
+++ b/docs/source/modules/flup.server.fcgi.rst
@@ -0,0 +1,7 @@
+:mod:`flup.server.fcgi` - fcgi - a FastCGI/WSGI gateway (threaded)
+==================================================================
+
+.. automodule:: flup.server.fcgi
+ :members:
+ :undoc-members:
+ :inherited-members:
diff --git a/docs/source/modules/flup.server.fcgi_base.rst b/docs/source/modules/flup.server.fcgi_base.rst
new file mode 100644
index 0000000..99140de
--- /dev/null
+++ b/docs/source/modules/flup.server.fcgi_base.rst
@@ -0,0 +1,7 @@
+:mod:`flup.server.fcgi_base` - fcgi - a FastCGI/WSGI gateway
+============================================================
+
+.. automodule:: flup.server.fcgi_base
+ :members:
+ :undoc-members:
+ :inherited-members:
diff --git a/docs/source/modules/flup.server.fcgi_fork.rst b/docs/source/modules/flup.server.fcgi_fork.rst
new file mode 100644
index 0000000..649b0db
--- /dev/null
+++ b/docs/source/modules/flup.server.fcgi_fork.rst
@@ -0,0 +1,7 @@
+:mod:`flup.server.fcgi_fork` - fcgi - a FastCGI/WSGI gateway (forking)
+======================================================================
+
+.. automodule:: flup.server.fcgi_fork
+ :members:
+ :undoc-members:
+ :inherited-members:
diff --git a/docs/source/modules/flup.server.fcgi_single.rst b/docs/source/modules/flup.server.fcgi_single.rst
new file mode 100644
index 0000000..349d673
--- /dev/null
+++ b/docs/source/modules/flup.server.fcgi_single.rst
@@ -0,0 +1,7 @@
+:mod:`flup.server.fcgi_single` - fcgi - a FastCGI/WSGI gateway (single-threaded)
+================================================================================
+
+.. automodule:: flup.server.fcgi_single
+ :members:
+ :undoc-members:
+ :inherited-members:
diff --git a/docs/source/modules/flup.server.paste_factory.rst b/docs/source/modules/flup.server.paste_factory.rst
new file mode 100644
index 0000000..b427f20
--- /dev/null
+++ b/docs/source/modules/flup.server.paste_factory.rst
@@ -0,0 +1,8 @@
+:mod:`flup.server.paste_factory`
+================================
+
+.. automodule:: flup.server.paste_factory
+ :members:
+ :undoc-members:
+ :inherited-members:
+
diff --git a/docs/source/modules/flup.server.preforkserver.rst b/docs/source/modules/flup.server.preforkserver.rst
new file mode 100644
index 0000000..04ea2d8
--- /dev/null
+++ b/docs/source/modules/flup.server.preforkserver.rst
@@ -0,0 +1,9 @@
+:mod:`flup.server.preforkserver`
+================================
+
+.. automodule:: flup.server.preforkserver
+ :members:
+ :undoc-members:
+ :inherited-members:
+
+
diff --git a/docs/source/modules/flup.server.scgi.rst b/docs/source/modules/flup.server.scgi.rst
new file mode 100644
index 0000000..c11e2b6
--- /dev/null
+++ b/docs/source/modules/flup.server.scgi.rst
@@ -0,0 +1,7 @@
+:mod:`flup.server.scgi` - scgi - an SCGI/WSGI gateway (threaded)
+================================================================
+
+.. automodule:: flup.server.scgi
+ :members:
+ :undoc-members:
+ :inherited-members:
diff --git a/docs/source/modules/flup.server.scgi_base.rst b/docs/source/modules/flup.server.scgi_base.rst
new file mode 100644
index 0000000..43c1a9e
--- /dev/null
+++ b/docs/source/modules/flup.server.scgi_base.rst
@@ -0,0 +1,7 @@
+:mod:`flup.server.scgi_base` - scgi - an SCGI/WSGI gateway
+==========================================================
+
+.. automodule:: flup.server.scgi_base
+ :members:
+ :undoc-members:
+ :inherited-members:
diff --git a/docs/source/modules/flup.server.scgi_fork.rst b/docs/source/modules/flup.server.scgi_fork.rst
new file mode 100644
index 0000000..4f97e74
--- /dev/null
+++ b/docs/source/modules/flup.server.scgi_fork.rst
@@ -0,0 +1,7 @@
+:mod:`flup.server.scgi_fork` - scgi - an SCGI/WSGI gateway (forking)
+====================================================================
+
+.. automodule:: flup.server.scgi_fork
+ :members:
+ :undoc-members:
+ :inherited-members:
diff --git a/docs/source/modules/flup.server.singleserver.rst b/docs/source/modules/flup.server.singleserver.rst
new file mode 100644
index 0000000..689ebc4
--- /dev/null
+++ b/docs/source/modules/flup.server.singleserver.rst
@@ -0,0 +1,9 @@
+:mod:`flup.server.singleserver`
+===============================
+
+.. automodule:: flup.server.singleserver
+ :members:
+ :undoc-members:
+ :inherited-members:
+
+
diff --git a/docs/source/modules/flup.server.threadedserver.rst b/docs/source/modules/flup.server.threadedserver.rst
new file mode 100644
index 0000000..2eb92fc
--- /dev/null
+++ b/docs/source/modules/flup.server.threadedserver.rst
@@ -0,0 +1,9 @@
+:mod:`flup.server.threadedserver`
+=================================
+
+.. automodule:: flup.server.threadedserver
+ :members:
+ :undoc-members:
+ :inherited-members:
+
+
diff --git a/docs/source/modules/flup.server.threadpool.rst b/docs/source/modules/flup.server.threadpool.rst
new file mode 100644
index 0000000..375ec8f
--- /dev/null
+++ b/docs/source/modules/flup.server.threadpool.rst
@@ -0,0 +1,8 @@
+:mod:`flup.server.threadpool`
+=============================
+
+.. automodule:: flup.server.threadpool
+ :members:
+ :undoc-members:
+ :inherited-members:
+