From cb676217ddde3af4a4ef6d6775b4713a98b5d3bb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Piotr=20Ma=C5=9Blanka?= <piotr.maslanka@henrietta.com.pl>
Date: Wed, 13 Nov 2024 14:04:17 +0100
Subject: [PATCH] docs fix
---
docs/reference.rst | 32 ++++++++++++++++++++++----------
docs/tutorials.rst | 18 +++++++++++++++++-
2 files changed, 39 insertions(+), 11 deletions(-)
diff --git a/docs/reference.rst b/docs/reference.rst
index 1074dad..a5cf4ea 100644
--- a/docs/reference.rst
+++ b/docs/reference.rst
@@ -1,20 +1,14 @@
-CoolAMQP cluster reference
+CoolAMQP classes reference
==========================
+Cluster-related things
+----------------------
+
.. autoclass:: coolamqp.clustering.Cluster
:members:
.. note:: If environment variable :code:`COOLAMQP_FORCE_SELECT_LISTENER` is defined, select will be used instead of epoll.
-Publisher
----------
-
-.. autoclass:: coolamqp.attaches.publisher.Publisher
- :members:
- :undoc-members:
-
-Consumers
----------
.. autoclass:: coolamqp.attaches.consumer.BodyReceiveMode
:members:
@@ -26,4 +20,22 @@ Consumers
Please note that :meth:`coolamqp.clustering.Cluster.consume` passes lot of it's
args and kwargs directly to the :class:`coolamqp.attaches.consumer.Consumer`.
+Extra objects
+-------------
+
+.. class:: coolamqp.objects.Message
+ :members:
+
+.. class:: coolamqp.objects.ReceivedMessage
+ :members:
+
+.. class:: coolamqp.objects.MessageProperties
+ :members:
+
+.. class:: coolamqp.objects.Queue
+ :members:
+
+.. class:: coolamqp.objects.Exchange
+ :members:
+
diff --git a/docs/tutorials.rst b/docs/tutorials.rst
index 20a876a..ead10e0 100644
--- a/docs/tutorials.rst
+++ b/docs/tutorials.rst
@@ -103,4 +103,20 @@ And let's try to send something to this exchange:
from coolamqp.objects import Message
c.publish(Message(b'my bag of bytes'), exchange=xchg, confirm=True).result()
-And voila, we're done here!
\ No newline at end of file
+And voila, we're done here!
+
+Topic exchanges
+---------------
+
+Topic exchanges are a bit harder. Let's try them:
+
+
+.. code-block:: python
+
+ from coolamqp.cluster import Cluster
+ from coolamqp.objects import NodeDefinition, Exchange
+
+ nd = NodeDefinition('amqp://127.0.0.1:5672/vhost', user='test', password='test', heartbeat=30)
+ c = Cluster(nd)
+ c.start()
+ xchg = Exchange('my-exchange', type='topic')
--
GitLab