Mechanical addition of module docstrings.

doc/Makefile

@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line.
 SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
+SPHINXBUILD   = PYTHONPATH=../:$PYTHONPATH sphinx-build
 PAPER         =
 
 # Internal variables.

doc/conf.py

@@ -24,6 +24,10 @@ import sys, os
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage']
 
+# If this is True, '.. todo::' and '.. todolist::' produce output, else they produce
+# nothing. The default is False.
+todo_include_todos = True
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -173,7 +177,7 @@ htmlhelp_basename = 'Eventletdoc'
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
   ('index', 'Eventlet.tex', u'Eventlet Documentation',
-   u'Donovan Preston, Denis Bilenko, Ryan Williams', 'manual'),
+   u'<eventlet contributors>', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of

doc/index.rst

@@ -3,7 +3,7 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to Eventlet's documentation!
+Eventlet
 ====================================
 
 Contents:
@@ -11,6 +11,8 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
+   modules.rst
+
 Indices and tables
 ==================
 

doc/modules.rst

@@ -0,0 +1,29 @@
+Module Reference
+======================
+
+.. toctree::
+   :maxdepth: 2
+
+   modules/api
+   modules/backdoor
+   modules/channel
+   modules/corolocal
+   modules/coros
+   modules/db_pool
+   modules/greenio
+   modules/greenlib
+   modules/httpc
+   modules/httpdate
+   modules/httpd
+   modules/jsonhttp
+   modules/logutil
+   modules/oldchannel
+   modules/pool
+   modules/pools
+   modules/processes
+   modules/proc
+   modules/saranwrap
+   modules/timer
+   modules/tpool
+   modules/util
+   modules/wsgi

doc/modules/api.rst

@@ -0,0 +1,6 @@
+Api
+==================
+
+.. automodule:: eventlet.api
+	:members:
+	:undoc-members:

doc/modules/backdoor.rst

@@ -0,0 +1,6 @@
+Backdoor
+==================
+
+.. automodule:: eventlet.backdoor
+	:members:
+	:undoc-members:

doc/modules/channel.rst

@@ -0,0 +1,6 @@
+Channel
+==================
+
+.. automodule:: eventlet.channel
+	:members:
+	:undoc-members:

doc/modules/corolocal.rst

@@ -0,0 +1,6 @@
+Corolocal
+==================
+
+.. automodule:: eventlet.corolocal
+	:members:
+	:undoc-members:

doc/modules/coros.rst

@@ -0,0 +1,6 @@
+Coros
+==================
+
+.. automodule:: eventlet.coros
+	:members:
+	:undoc-members:

doc/modules/db_pool.rst

@@ -0,0 +1,6 @@
+Db_pool
+==================
+
+.. automodule:: eventlet.db_pool
+	:members:
+	:undoc-members:

doc/modules/greenio.rst

@@ -0,0 +1,6 @@
+Greenio
+==================
+
+.. automodule:: eventlet.greenio
+	:members:
+	:undoc-members:

doc/modules/greenlib.rst

@@ -0,0 +1,6 @@
+Greenlib
+==================
+
+.. automodule:: eventlet.greenlib
+	:members:
+	:undoc-members:

doc/modules/httpc.rst

@@ -0,0 +1,6 @@
+Httpc
+==================
+
+.. automodule:: eventlet.httpc
+	:members:
+	:undoc-members:

doc/modules/httpd.rst

@@ -0,0 +1,6 @@
+Httpd
+==================
+
+.. automodule:: eventlet.httpd
+	:members:
+	:undoc-members:

doc/modules/httpdate.rst

@@ -0,0 +1,6 @@
+Httpdate
+==================
+
+.. automodule:: eventlet.httpdate
+	:members:
+	:undoc-members:

doc/modules/jsonhttp.rst

@@ -0,0 +1,6 @@
+Jsonhttp
+==================
+
+.. automodule:: eventlet.jsonhttp
+	:members:
+	:undoc-members:

doc/modules/logutil.rst

@@ -0,0 +1,6 @@
+Logutil
+==================
+
+.. automodule:: eventlet.logutil
+	:members:
+	:undoc-members:

doc/modules/oldchannel.rst

@@ -0,0 +1,6 @@
+Oldchannel
+==================
+
+.. automodule:: eventlet.oldchannel
+	:members:
+	:undoc-members:

doc/modules/pool.rst

@@ -0,0 +1,6 @@
+Pool
+==================
+
+.. automodule:: eventlet.pool
+	:members:
+	:undoc-members:

doc/modules/pools.rst

@@ -0,0 +1,6 @@
+Pools
+==================
+
+.. automodule:: eventlet.pools
+	:members:
+	:undoc-members:

doc/modules/proc.rst

@@ -0,0 +1,6 @@
+Proc
+==================
+
+.. automodule:: eventlet.proc
+	:members:
+	:undoc-members:

doc/modules/processes.rst

@@ -0,0 +1,6 @@
+Processes
+==================
+
+.. automodule:: eventlet.processes
+	:members:
+	:undoc-members:

doc/modules/saranwrap.rst

@@ -0,0 +1,6 @@
+Saranwrap
+==================
+
+.. automodule:: eventlet.saranwrap
+	:members:
+	:undoc-members:

doc/modules/template

@@ -0,0 +1,6 @@
+Module
+==================
+
+.. automodule:: modgool
+	:members:
+	:undoc-members:

doc/modules/timer.rst

@@ -0,0 +1,6 @@
+Timer
+==================
+
+.. automodule:: eventlet.timer
+	:members:
+	:undoc-members:

doc/modules/tpool.rst

@@ -0,0 +1,6 @@
+Tpool
+==================
+
+.. automodule:: eventlet.tpool
+	:members:
+	:undoc-members:

doc/modules/util.rst

@@ -0,0 +1,6 @@
+Util
+==================
+
+.. automodule:: eventlet.util
+	:members:
+	:undoc-members:

doc/modules/wsgi.rst

@@ -0,0 +1,6 @@
+Wsgi
+==================
+
+.. automodule:: eventlet.wsgi
+	:members:
+	:undoc-members: