diff --git a/doc/Makefile b/doc/Makefile index ba62f17..9369df3 100644 --- a/doc/Makefile +++ b/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. diff --git a/doc/conf.py b/doc/conf.py index b69532b..d7338e2 100644 --- a/doc/conf.py +++ b/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'', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of diff --git a/doc/index.rst b/doc/index.rst index 579b913..4ebd72a 100644 --- a/doc/index.rst +++ b/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 ================== diff --git a/doc/modules.rst b/doc/modules.rst new file mode 100644 index 0000000..8f29970 --- /dev/null +++ b/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 diff --git a/doc/modules/api.rst b/doc/modules/api.rst new file mode 100644 index 0000000..cc4b0f1 --- /dev/null +++ b/doc/modules/api.rst @@ -0,0 +1,6 @@ +Api +================== + +.. automodule:: eventlet.api + :members: + :undoc-members: diff --git a/doc/modules/backdoor.rst b/doc/modules/backdoor.rst new file mode 100644 index 0000000..bd1022e --- /dev/null +++ b/doc/modules/backdoor.rst @@ -0,0 +1,6 @@ +Backdoor +================== + +.. automodule:: eventlet.backdoor + :members: + :undoc-members: diff --git a/doc/modules/channel.rst b/doc/modules/channel.rst new file mode 100644 index 0000000..22ab4c5 --- /dev/null +++ b/doc/modules/channel.rst @@ -0,0 +1,6 @@ +Channel +================== + +.. automodule:: eventlet.channel + :members: + :undoc-members: diff --git a/doc/modules/corolocal.rst b/doc/modules/corolocal.rst new file mode 100644 index 0000000..122030f --- /dev/null +++ b/doc/modules/corolocal.rst @@ -0,0 +1,6 @@ +Corolocal +================== + +.. automodule:: eventlet.corolocal + :members: + :undoc-members: diff --git a/doc/modules/coros.rst b/doc/modules/coros.rst new file mode 100644 index 0000000..f5ed2c3 --- /dev/null +++ b/doc/modules/coros.rst @@ -0,0 +1,6 @@ +Coros +================== + +.. automodule:: eventlet.coros + :members: + :undoc-members: diff --git a/doc/modules/db_pool.rst b/doc/modules/db_pool.rst new file mode 100644 index 0000000..59e02f6 --- /dev/null +++ b/doc/modules/db_pool.rst @@ -0,0 +1,6 @@ +Db_pool +================== + +.. automodule:: eventlet.db_pool + :members: + :undoc-members: diff --git a/doc/modules/greenio.rst b/doc/modules/greenio.rst new file mode 100644 index 0000000..ada72dc --- /dev/null +++ b/doc/modules/greenio.rst @@ -0,0 +1,6 @@ +Greenio +================== + +.. automodule:: eventlet.greenio + :members: + :undoc-members: diff --git a/doc/modules/greenlib.rst b/doc/modules/greenlib.rst new file mode 100644 index 0000000..4021820 --- /dev/null +++ b/doc/modules/greenlib.rst @@ -0,0 +1,6 @@ +Greenlib +================== + +.. automodule:: eventlet.greenlib + :members: + :undoc-members: diff --git a/doc/modules/httpc.rst b/doc/modules/httpc.rst new file mode 100644 index 0000000..df3b049 --- /dev/null +++ b/doc/modules/httpc.rst @@ -0,0 +1,6 @@ +Httpc +================== + +.. automodule:: eventlet.httpc + :members: + :undoc-members: diff --git a/doc/modules/httpd.rst b/doc/modules/httpd.rst new file mode 100644 index 0000000..7f50c6c --- /dev/null +++ b/doc/modules/httpd.rst @@ -0,0 +1,6 @@ +Httpd +================== + +.. automodule:: eventlet.httpd + :members: + :undoc-members: diff --git a/doc/modules/httpdate.rst b/doc/modules/httpdate.rst new file mode 100644 index 0000000..d4802a9 --- /dev/null +++ b/doc/modules/httpdate.rst @@ -0,0 +1,6 @@ +Httpdate +================== + +.. automodule:: eventlet.httpdate + :members: + :undoc-members: diff --git a/doc/modules/jsonhttp.rst b/doc/modules/jsonhttp.rst new file mode 100644 index 0000000..56dfcc1 --- /dev/null +++ b/doc/modules/jsonhttp.rst @@ -0,0 +1,6 @@ +Jsonhttp +================== + +.. automodule:: eventlet.jsonhttp + :members: + :undoc-members: diff --git a/doc/modules/logutil.rst b/doc/modules/logutil.rst new file mode 100644 index 0000000..9b30824 --- /dev/null +++ b/doc/modules/logutil.rst @@ -0,0 +1,6 @@ +Logutil +================== + +.. automodule:: eventlet.logutil + :members: + :undoc-members: diff --git a/doc/modules/oldchannel.rst b/doc/modules/oldchannel.rst new file mode 100644 index 0000000..522bd1c --- /dev/null +++ b/doc/modules/oldchannel.rst @@ -0,0 +1,6 @@ +Oldchannel +================== + +.. automodule:: eventlet.oldchannel + :members: + :undoc-members: diff --git a/doc/modules/pool.rst b/doc/modules/pool.rst new file mode 100644 index 0000000..8a43a28 --- /dev/null +++ b/doc/modules/pool.rst @@ -0,0 +1,6 @@ +Pool +================== + +.. automodule:: eventlet.pool + :members: + :undoc-members: diff --git a/doc/modules/pools.rst b/doc/modules/pools.rst new file mode 100644 index 0000000..031739d --- /dev/null +++ b/doc/modules/pools.rst @@ -0,0 +1,6 @@ +Pools +================== + +.. automodule:: eventlet.pools + :members: + :undoc-members: diff --git a/doc/modules/proc.rst b/doc/modules/proc.rst new file mode 100644 index 0000000..91ee39f --- /dev/null +++ b/doc/modules/proc.rst @@ -0,0 +1,6 @@ +Proc +================== + +.. automodule:: eventlet.proc + :members: + :undoc-members: diff --git a/doc/modules/processes.rst b/doc/modules/processes.rst new file mode 100644 index 0000000..6efbb2d --- /dev/null +++ b/doc/modules/processes.rst @@ -0,0 +1,6 @@ +Processes +================== + +.. automodule:: eventlet.processes + :members: + :undoc-members: diff --git a/doc/modules/saranwrap.rst b/doc/modules/saranwrap.rst new file mode 100644 index 0000000..b3f0f11 --- /dev/null +++ b/doc/modules/saranwrap.rst @@ -0,0 +1,6 @@ +Saranwrap +================== + +.. automodule:: eventlet.saranwrap + :members: + :undoc-members: diff --git a/doc/modules/template b/doc/modules/template new file mode 100644 index 0000000..0f6ee60 --- /dev/null +++ b/doc/modules/template @@ -0,0 +1,6 @@ +Module +================== + +.. automodule:: modgool + :members: + :undoc-members: diff --git a/doc/modules/timer.rst b/doc/modules/timer.rst new file mode 100644 index 0000000..3e2939e --- /dev/null +++ b/doc/modules/timer.rst @@ -0,0 +1,6 @@ +Timer +================== + +.. automodule:: eventlet.timer + :members: + :undoc-members: diff --git a/doc/modules/tpool.rst b/doc/modules/tpool.rst new file mode 100644 index 0000000..0c72578 --- /dev/null +++ b/doc/modules/tpool.rst @@ -0,0 +1,6 @@ +Tpool +================== + +.. automodule:: eventlet.tpool + :members: + :undoc-members: diff --git a/doc/modules/util.rst b/doc/modules/util.rst new file mode 100644 index 0000000..a18b0fd --- /dev/null +++ b/doc/modules/util.rst @@ -0,0 +1,6 @@ +Util +================== + +.. automodule:: eventlet.util + :members: + :undoc-members: diff --git a/doc/modules/wsgi.rst b/doc/modules/wsgi.rst new file mode 100644 index 0000000..6bac5e1 --- /dev/null +++ b/doc/modules/wsgi.rst @@ -0,0 +1,6 @@ +Wsgi +================== + +.. automodule:: eventlet.wsgi + :members: + :undoc-members: