From 32227f9c3a63797319ba4d4c34443a7a00eb9e38 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Piotr=20Ma=C5=9Blanka?= <piotr.maslanka@henrietta.com.pl>
Date: Fri, 3 Jan 2020 15:27:47 +0100
Subject: [PATCH] docs update
---
LICENSE | 2 +-
README.md | 2 +-
docs/conf.py | 8 ++++----
docs/tutorial.rst | 16 ++++++++++++++--
setup.cfg | 2 +-
5 files changed, 21 insertions(+), 9 deletions(-)
diff --git a/LICENSE b/LICENSE
index e47e3d0..91e36a8 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,7 +1,7 @@
The MIT License (MIT)
Copyright (c) 2016-2018 DMS Serwis s.c.
-Copyright (c) 2018-2019 SMOK sp. z o.o.
+Copyright (c) 2018-2020 SMOK sp. z o.o.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
index edfee7a..ca9f7db 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@ CoolAMQP
[]()
[]()
[]()
-[](http://coolamqp.readthedocs.io/en/latest/?badge=latest)
+[](http://coolamqp.readthedocs.io/en/latest/?badge=develop)
[]()
A **magical** AMQP client, that uses **heavy sorcery** to achieve speeds that other AMQP clients cannot even hope to match.
diff --git a/docs/conf.py b/docs/conf.py
index 2edc8d7..65811d1 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -32,7 +32,7 @@ source_parsers = {
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
-extensions = []
+extensions = ['sphinx.ext.autodoc']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -47,7 +47,7 @@ master_doc = 'index'
# General information about the project.
project = u'CoolAMQP'
-copyright = u'2016-2019, SMOK Serwis s.c.'
+copyright = u'2016-2020, SMOK Serwis s.c.'
author = u'DMS Serwis s.c.'
# The version info for the project you're documenting, acts as replacement for
@@ -55,9 +55,9 @@ author = u'DMS Serwis s.c.'
# built documents.
#
# The short X.Y version.
-version = '0.93'
+version = '0.100'
# The full version, including alpha/beta/rc tags.
-release = u'0.93'
+release = u'0.100a1'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
diff --git a/docs/tutorial.rst b/docs/tutorial.rst
index e0fc3e6..0196f57 100644
--- a/docs/tutorial.rst
+++ b/docs/tutorial.rst
@@ -53,7 +53,10 @@ This will create an auto-delete and exclusive queue. After than, a consumer will
_no_ack=False_ will mean that we have to manually confirm messages.
You can specify a callback, that will be called with a message if one's received by this consumer. Since
-we did not do that, this will go to a generic queue belonging to _Cluster_.
+we did not do that, this will go to a generic queue belonging to _Cluster_.
+
+.. autoclass: coolamqp.clustering.Cluster
+:members:
_consumer_ is a _Consumer_ object. This allows us to do some things with the consumer (such as setting QoS),
but most importantly it allows us to cancel it later. _consume_confirm_ is a _Future_, that will succeed
@@ -75,4 +78,13 @@ This creates a message with no properties, and sends it through default (direct)
Note that CoolAMQP simply considers your messages to be bags of bytes + properties. It will not modify them,
nor decode, and will always expect and return bytes.
-To actually get our message ...
\ No newline at end of file
+To actually get our message, we need to start a consumer first. To do that, just invoke:
+
+::
+
+ cluster.consume(Queue('name of the queue'), **kwargs)
+
+Where kwargs are passed directly to Consumer class
+
+.. autoclass: coolamqp.attaches.Consumer
+:members:
diff --git a/setup.cfg b/setup.cfg
index ec4cc06..70fafaf 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -1,7 +1,7 @@
[metadata]
description-file = README.md
name = CoolAMQP
-version = 0.98
+version = 0.100a1
license = MIT License
classifiers =
Programming Language :: Python
--
GitLab