zmq: autogenerated documentation was missing

This commit is contained in:
Sergey Shepelev 2016-12-12 00:32:41 +03:00
parent 594faaca6b
commit f52c4d31b6
3 changed files with 8 additions and 21 deletions

View File

@ -1,14 +1,15 @@
:mod:`eventlet.green.zmq` -- ØMQ support
========================================
:mod:`pyzmq <zmq>` [1]_ is a python binding to the C++ ØMQ [2]_ library written in Cython [3]_.
:mod:`eventlet.green.zmq` is greenthread aware version of `pyzmq`.
.. automodule:: eventlet.green.zmq
:show-inheritance:
.. currentmodule:: eventlet.green.zmq
.. autofunction:: Context
.. autoclass:: _Context
.. autoclass:: Context
:show-inheritance:
.. automethod:: socket
@ -23,20 +24,6 @@
.. module:: zmq
:mod:`zmq` -- The pyzmq ØMQ python bindings
===========================================
:mod:`pyzmq <zmq>` [1]_ Is a python binding to the C++ ØMQ [2]_ library written in Cython [3]_. The following is
auto generated :mod:`pyzmq's <zmq>` from documentation.
.. autoclass:: zmq.core.context.Context
:members:
.. autoclass:: zmq.core.socket.Socket
.. autoclass:: zmq.core.poll.Poller
:members:
.. [1] http://github.com/zeromq/pyzmq
.. [2] http://www.zeromq.com

View File

@ -26,4 +26,4 @@ while simultaneously accepting incoming connections from multiple endpoints boun
API documentation
=================
ØMQ support is provided in the :mod:`eventlet.green.zmq` module
ØMQ support is provided in the :mod:`eventlet.green.zmq` module.

View File

@ -123,13 +123,13 @@ class _BlockedThread(object):
class Context(__zmq__.Context):
"""Subclass of :class:`zmq.core.context.Context`
"""Subclass of :class:`zmq.Context`
"""
def socket(self, socket_type):
"""Overridden method to ensure that the green version of socket is used
Behaves the same as :meth:`zmq.core.context.Context.socket`, but ensures
Behaves the same as :meth:`zmq.Context.socket`, but ensures
that a :class:`Socket` with all of its send and recv methods set to be
non-blocking is returned
"""
@ -446,4 +446,4 @@ class Socket(_Socket):
# acquire lock here so the subsequent calls to recv for the
# message parts after the first don't block
with self._eventlet_recv_lock:
return _Socket_recv_json(self, flags, copy, track)
return _Socket_recv_json(self, flags, copy, track)