From a91f3b95acfd6bf20d88c8dfdca7bf6a42472795 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Piotr=20Ma=C5=9Blanka?= <piotr.maslanka@ericsson.com>
Date: Mon, 2 Sep 2024 15:39:08 +0200
Subject: [PATCH] improve docs
---
coolamqp/clustering/cluster.py | 3 +--
docs/advanced.rst | 5 +++++
docs/index.rst | 1 +
3 files changed, 7 insertions(+), 2 deletions(-)
create mode 100644 docs/advanced.rst
diff --git a/coolamqp/clustering/cluster.py b/coolamqp/clustering/cluster.py
index 5e63a50..b81c262 100644
--- a/coolamqp/clustering/cluster.py
+++ b/coolamqp/clustering/cluster.py
@@ -38,8 +38,7 @@ class Cluster(object):
:param nodes: list of nodes, or a single node. For now, only one is supported.
:param on_fail: callable/0 to call when connection fails in an
unclean way. This is a one-shot
- :param extra_properties: refer to documentation in [/coolamqp/connection/connection.py]
- Connection.__init__
+ :param extra_properties: refer to :class:`coolamqp.uplink.connection.Connection`
:param log_frames: an object that supports logging each and every frame CoolAMQP sends and
receives from the broker
:type log_frames: tp.Optional[:class:`coolamqp.tracing.BaseFrameTracer`]
diff --git a/docs/advanced.rst b/docs/advanced.rst
new file mode 100644
index 0000000..2f743c9
--- /dev/null
+++ b/docs/advanced.rst
@@ -0,0 +1,5 @@
+Advanced things
+===============
+
+.. autoclass:: coolamqp.uplink.connection.Connection
+ :members:
diff --git a/docs/index.rst b/docs/index.rst
index 69444a6..f7237ce 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -11,6 +11,7 @@ Welcome to CoolAMQP's documentation!
frames
basics
tracing
+ advanced
Quick FAQ
=========
--
GitLab