diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 2 | ||||
| -rw-r--r-- | docs/reference/index.rst | 6 | ||||
| -rw-r--r-- | docs/reference/kombu.rst | 18 | ||||
| -rw-r--r-- | docs/reference/kombu.simple.rst | 4 | ||||
| -rw-r--r-- | docs/reference/kombu.transport.pika.rst | 46 | ||||
| -rw-r--r-- | docs/reference/kombu.transport.pika2.rst | 34 | ||||
| -rw-r--r-- | docs/reference/kombu.transport.zmq.rst | 4 | ||||
| -rw-r--r-- | docs/reference/kombu.transport.zookeeper.rst | 4 | ||||
| -rw-r--r-- | docs/reference/kombu.utils.eventio.rst | 11 | ||||
| -rw-r--r-- | docs/userguide/connections.rst | 7 | ||||
| -rw-r--r-- | docs/userguide/consumers.rst | 7 | ||||
| -rw-r--r-- | docs/userguide/producers.rst | 5 | ||||
| -rw-r--r-- | docs/userguide/serialization.rst | 28 | ||||
| -rw-r--r-- | docs/userguide/simple.rst | 2 |
14 files changed, 53 insertions, 125 deletions
diff --git a/docs/conf.py b/docs/conf.py index af7be574..27534746 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -46,7 +46,7 @@ exclude_trees = ['.build'] add_function_parentheses = True # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'trac' +pygments_style = 'colorful' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/docs/reference/index.rst b/docs/reference/index.rst index 1cdb4bc2..c09075a0 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -25,9 +25,6 @@ kombu.transport kombu.transport.pyamqp kombu.transport.librabbitmq - kombu.transport.pika - kombu.transport.pika2 - kombu.transport.amqplib kombu.transport.memory kombu.transport.redis kombu.transport.zmq @@ -43,15 +40,18 @@ kombu.transport.sqlalchemy kombu.transport.sqlalchemy.models kombu.transport.SQS + kombu.transport.amqplib kombu.transport.base kombu.transport.virtual kombu.transport.virtual.exchange kombu.transport.virtual.scheduling kombu.serialization kombu.utils + kombu.utils.eventio kombu.utils.limits kombu.utils.compat kombu.utils.debug kombu.utils.encoding kombu.utils.functional kombu.utils.url + kombu.utils.amq_manager diff --git a/docs/reference/kombu.rst b/docs/reference/kombu.rst index 71aa62ec..46fceeaf 100644 --- a/docs/reference/kombu.rst +++ b/docs/reference/kombu.rst @@ -1,11 +1,11 @@ .. currentmodule:: kombu -.. automodule:: kombu +.. contents:: + :local: - .. contents:: - :local: +.. automodule:: kombu - Connection + Connection ---------- .. autoclass:: Connection @@ -73,8 +73,6 @@ .. automethod:: SimpleQueue .. automethod:: SimpleBuffer - - Exchange -------- @@ -110,9 +108,9 @@ Example creating a queue using our exchange in the :class:`Exchange` example:: - >>> science_news = Queue("science_news", + >>> science_news = Queue('science_news', ... exchange=news_exchange, - ... routing_key="news.science") + ... routing_key='news.science') For now `science_news` is just a declaration, you can't perform actions on it. It just describes the name and options for the queue. @@ -124,7 +122,9 @@ >>> bound_science_news = science_news(channel) - Now you can perform operations like :meth:`declare` or :meth:`purge`:: + Now you can perform operations like :meth:`declare` or :meth:`purge`: + + .. code-block:: python >>> bound_sicence_news.declare() >>> bound_science_news.purge() diff --git a/docs/reference/kombu.simple.rst b/docs/reference/kombu.simple.rst index bee729df..b43e2ec8 100644 --- a/docs/reference/kombu.simple.rst +++ b/docs/reference/kombu.simple.rst @@ -28,7 +28,7 @@ .. attribute:: queue - :class:`~kombu.entity.Queue` to consume from (if consuming). + :class:`~kombu.Queue` to consume from (if consuming). .. attribute:: queue_opts @@ -69,7 +69,7 @@ .. attribute:: queue - :class:`~kombu.entity.Queue` to consume from (if consuming). + :class:`~kombu.Queue` to consume from (if consuming). .. attribute:: queue_opts diff --git a/docs/reference/kombu.transport.pika.rst b/docs/reference/kombu.transport.pika.rst deleted file mode 100644 index 783af0d6..00000000 --- a/docs/reference/kombu.transport.pika.rst +++ /dev/null @@ -1,46 +0,0 @@ -======================================= - kombu.transport.pika -======================================= - -.. currentmodule:: kombu.transport.pika - -.. automodule:: kombu.transport.pika - - .. contents:: - :local: - - Transports - ---------- - - .. autoclass:: AsyncoreTransport - :members: - :undoc-members: - - .. autoclass:: SyncTransport - :members: - :undoc-members: - - Connections - ----------- - - .. autoclass:: AsyncoreConnection - :members: - :undoc-members: - - .. autoclass:: BlockingConnection - :members: - :undoc-members: - - Channel - ------- - - .. autoclass:: Channel - :members: - :undoc-members: - - Message - ------- - - .. autoclass:: Message - :members: - :undoc-members: diff --git a/docs/reference/kombu.transport.pika2.rst b/docs/reference/kombu.transport.pika2.rst deleted file mode 100644 index b06dd0a7..00000000 --- a/docs/reference/kombu.transport.pika2.rst +++ /dev/null @@ -1,34 +0,0 @@ -.. currentmodule:: kombu.transport.pika2 - -.. automodule:: kombu.transport.pika2 - - .. contents:: - :local: - - Transport - --------- - - .. autoclass:: Transport - :members: - :undoc-members: - - Connection - ---------- - - .. autoclass:: Connection - :members: - :undoc-members: - - Channel - ------- - - .. autoclass:: Channel - :members: - :undoc-members: - - Message - ------- - - .. autoclass:: Message - :members: - :undoc-members: diff --git a/docs/reference/kombu.transport.zmq.rst b/docs/reference/kombu.transport.zmq.rst index 0735840b..08d0ea5e 100644 --- a/docs/reference/kombu.transport.zmq.rst +++ b/docs/reference/kombu.transport.zmq.rst @@ -1,3 +1,7 @@ +===================== + kombu.transport.zmq +===================== + .. currentmodule:: kombu.transport.zmq .. automodule:: kombu.transport.zmq diff --git a/docs/reference/kombu.transport.zookeeper.rst b/docs/reference/kombu.transport.zookeeper.rst index 976ad6af..af900a35 100644 --- a/docs/reference/kombu.transport.zookeeper.rst +++ b/docs/reference/kombu.transport.zookeeper.rst @@ -1,3 +1,7 @@ +=========================== + kombu.transport.zookeeper +=========================== + .. currentmodule:: kombu.transport.zookeeper .. automodule:: kombu.transport.zookeeper diff --git a/docs/reference/kombu.utils.eventio.rst b/docs/reference/kombu.utils.eventio.rst new file mode 100644 index 00000000..16c40f33 --- /dev/null +++ b/docs/reference/kombu.utils.eventio.rst @@ -0,0 +1,11 @@ +========================================================== + Evented I/O - kombu.utils.eventio +========================================================== + +.. contents:: + :local: +.. currentmodule:: kombu.utils.eventio + +.. automodule:: kombu.utils.eventio + :members: + :undoc-members: diff --git a/docs/userguide/connections.rst b/docs/userguide/connections.rst index d7275ea4..aa88add8 100644 --- a/docs/userguide/connections.rst +++ b/docs/userguide/connections.rst @@ -116,10 +116,7 @@ keyword arguments, these are: :ssl: Use SSL to connect to the server. Default is ``False``. Only supported by the amqp transport. :insist: Insist on connecting to a server. - In a configuration with multiple load-sharing servers, the insist - option tells the server that the client is insisting on a connection - to the specified server. Default is ``False``. - Only supported by the amqp and pika transports, and not by AMQP 0-9-1. + *No longer supported, relic from AMQP 0.8* :connect_timeout: Timeout in seconds for connecting to the server. May not be supported by the specified transport. :transport_options: A dict of additional connection arguments to @@ -142,8 +139,6 @@ Transport Comparison +---------------+----------+------------+------------+---------------+ | *SQS* | Virtual | Yes | Yes [#f1]_ | Yes [#f2]_ | +---------------+----------+------------+------------+---------------+ -| *pika* | Native | Yes | Yes | Yes | -+---------------+----------+------------+------------+---------------+ | *couchdb* | Virtual | Yes | Yes [#f1]_ | No | +---------------+----------+------------+------------+---------------+ | *zookeeper* | Virtual | Yes | Yes [#f1]_ | No | diff --git a/docs/userguide/consumers.rst b/docs/userguide/consumers.rst index 74ab79cf..5e9d3d61 100644 --- a/docs/userguide/consumers.rst +++ b/docs/userguide/consumers.rst @@ -1,4 +1,3 @@ -.. currentmodule:: kombu.messaging .. _guide-consumers: =========== @@ -62,7 +61,7 @@ and with multiple channels again: .. code-block:: python - from kombu.messaging import Consumer + from kombu import Consumer from kombu.mixins import ConsumerMixin class C(ConsumerMixin): @@ -88,8 +87,6 @@ and with multiple channels again: Reference ========= -.. module:: kombu.messaging - -.. autoclass:: Consumer +.. autoclass:: kombu.Consumer :noindex: :members: diff --git a/docs/userguide/producers.rst b/docs/userguide/producers.rst index c6e80625..454b4ca3 100644 --- a/docs/userguide/producers.rst +++ b/docs/userguide/producers.rst @@ -1,4 +1,3 @@ -.. currentmodule:: kombu.messaging .. _guide-producers: =========== @@ -20,8 +19,6 @@ See :ref:`guide-serialization`. Reference ========= -.. module:: kombu.messaging - -.. autoclass:: Producer +.. autoclass:: kombu.Producer :noindex: :members: diff --git a/docs/userguide/serialization.rst b/docs/userguide/serialization.rst index b3648d14..3f236861 100644 --- a/docs/userguide/serialization.rst +++ b/docs/userguide/serialization.rst @@ -138,24 +138,24 @@ supported by Kombu. .. admonition:: Buffer Objects -The decoder function of custom serializer must support both strings -and Python's old-style buffer objects. + The decoder function of custom serializer must support both strings + and Python's old-style buffer objects. -Python pickle and json modules usually don't do this via its ``loads`` -function, but you can easily add support by making a wrapper around the -``load`` function that takes file objects instead of strings. + Python pickle and json modules usually don't do this via its ``loads`` + function, but you can easily add support by making a wrapper around the + ``load`` function that takes file objects instead of strings. -Here's an example wrapping :func:`pickle.loads` in such a way: + Here's an example wrapping :func:`pickle.loads` in such a way: -.. code-block:: python + .. code-block:: python - import pickle - from kombu.serialization import BytesIO, register + import pickle + from kombu.serialization import BytesIO, register - def loads(s): - return pickle.load(BytesIO(s)) + def loads(s): + return pickle.load(BytesIO(s)) - register('my_pickle', loads, pickle.dumps, - content_type='application/x-pickle2', - content_encoding='binary') + register('my_pickle', loads, pickle.dumps, + content_type='application/x-pickle2', + content_encoding='binary') diff --git a/docs/userguide/simple.rst b/docs/userguide/simple.rst index 9239f118..69caaf2d 100644 --- a/docs/userguide/simple.rst +++ b/docs/userguide/simple.rst @@ -16,7 +16,7 @@ messaging needs. Instead of defining exchanges and queues, the simple classes only requires two arguments, a connection channel and a name. The name is used as the queue, exchange and routing key. If the need arises, you can specify -a :class:`~kombu.entity.Queue` as the name argument instead. +a :class:`~kombu.Queue` as the name argument instead. In addition, the :class:`~kombu.Connection` comes with shortcuts to create simple queues using the current connection:: |