diff options
| author | Ryan Williams <rdw@lindenlab.com> | 2010-01-18 15:42:15 -0800 |
|---|---|---|
| committer | Ryan Williams <rdw@lindenlab.com> | 2010-01-18 15:42:15 -0800 |
| commit | d2fa28ecdc83ed2c124743df2b3425374428542b (patch) | |
| tree | 8e3dffc5796f556cc4e8bbe6211e23acc27a11b3 /doc/modules | |
| parent | 9d07716c3572b6a9e4cad4f8084eb1c26a843068 (diff) | |
| download | eventlet-d2fa28ecdc83ed2c124743df2b3425374428542b.tar.gz | |
Doc improvements, removed docs for coros and proc modules.
Diffstat (limited to 'doc/modules')
| -rw-r--r-- | doc/modules/debug.rst | 5 | ||||
| -rw-r--r-- | doc/modules/event.rst | 5 | ||||
| -rw-r--r-- | doc/modules/greenio.rst | 1 | ||||
| -rw-r--r-- | doc/modules/greenthread.rst | 5 | ||||
| -rw-r--r-- | doc/modules/proc.rst | 6 | ||||
| -rw-r--r-- | doc/modules/processes.rst | 1 | ||||
| -rw-r--r-- | doc/modules/queue.rst | 5 | ||||
| -rw-r--r-- | doc/modules/saranwrap.rst | 1 | ||||
| -rw-r--r-- | doc/modules/semaphore.rst (renamed from doc/modules/coros.rst) | 4 |
9 files changed, 22 insertions, 11 deletions
diff --git a/doc/modules/debug.rst b/doc/modules/debug.rst new file mode 100644 index 0000000..03c2ddc --- /dev/null +++ b/doc/modules/debug.rst @@ -0,0 +1,5 @@ +:mod:`debug` -- Debugging tools for Eventlet +================================================== + +.. automodule:: eventlet.debug + :members: diff --git a/doc/modules/event.rst b/doc/modules/event.rst new file mode 100644 index 0000000..6774671 --- /dev/null +++ b/doc/modules/event.rst @@ -0,0 +1,5 @@ +:mod:`event` -- Cross-greenthread primitive +================================================== + +.. automodule:: eventlet.event + :members: diff --git a/doc/modules/greenio.rst b/doc/modules/greenio.rst index 2b5909b..05ca405 100644 --- a/doc/modules/greenio.rst +++ b/doc/modules/greenio.rst @@ -3,4 +3,3 @@ .. automodule:: eventlet.greenio :members: - :undoc-members: diff --git a/doc/modules/greenthread.rst b/doc/modules/greenthread.rst new file mode 100644 index 0000000..8367402 --- /dev/null +++ b/doc/modules/greenthread.rst @@ -0,0 +1,5 @@ +:mod:`greenthread` -- Green Thread Implementation +================================================== + +.. automodule:: eventlet.greenthread + :members: diff --git a/doc/modules/proc.rst b/doc/modules/proc.rst deleted file mode 100644 index f20433d..0000000 --- a/doc/modules/proc.rst +++ /dev/null @@ -1,6 +0,0 @@ -:mod:`proc` -- Advanced coroutine control -========================================== - -.. automodule:: eventlet.proc - :members: - :undoc-members: diff --git a/doc/modules/processes.rst b/doc/modules/processes.rst index 3669080..6ae5b15 100644 --- a/doc/modules/processes.rst +++ b/doc/modules/processes.rst @@ -3,4 +3,3 @@ .. automodule:: eventlet.processes :members: - :undoc-members: diff --git a/doc/modules/queue.rst b/doc/modules/queue.rst new file mode 100644 index 0000000..9c3a933 --- /dev/null +++ b/doc/modules/queue.rst @@ -0,0 +1,5 @@ +:mod:`queue` -- Queue class +======================================== + +.. automodule:: eventlet.queue + :members: diff --git a/doc/modules/saranwrap.rst b/doc/modules/saranwrap.rst index c9f1802..0d328fd 100644 --- a/doc/modules/saranwrap.rst +++ b/doc/modules/saranwrap.rst @@ -18,7 +18,6 @@ The objects so wrapped behave as if they are resident in the current process spa .. automodule:: eventlet.saranwrap :members: - :undoc-members: Underlying Protocol diff --git a/doc/modules/coros.rst b/doc/modules/semaphore.rst index 0778279..7d92ee4 100644 --- a/doc/modules/coros.rst +++ b/doc/modules/semaphore.rst @@ -1,6 +1,6 @@ -:mod:`coros` -- Coroutine communication patterns +:mod:`semaphore` -- Semaphore classes ================================================== -.. automodule:: eventlet.coros +.. automodule:: eventlet.semaphore :members: :undoc-members: |