From 106af1a8baaf7595787f51d1621b05b8ab321c64 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 13:52:35 +0100
Subject: [PATCH] docs fix
---
docs/basics.rst | 44 --------------------------------------------
docs/index.rst | 4 ++--
2 files changed, 2 insertions(+), 46 deletions(-)
delete mode 100644 docs/basics.rst
diff --git a/docs/basics.rst b/docs/basics.rst
deleted file mode 100644
index 1531b9b..0000000
--- a/docs/basics.rst
+++ /dev/null
@@ -1,44 +0,0 @@
-Usage basics
-============
-
-First off, you need a Cluster object:
-
-.. autoclass:: coolamqp.clustering.Cluster
- :members:
-
-You will need to initialize it with NodeDefinitions:
-
-.. autoclass:: coolamqp.objects.NodeDefinition
-
-You can send messages:
-
-.. autoclass:: coolamqp.objects.Message
-
-and receive them
-
-.. autoclass:: coolamqp.objects.ReceivedMessage
- :members:
-
-MessageProperties
------------------
-
-.. autoclass:: coolamqp.objects.MessageProperties
- :members:
-
-.. autoclass:: coolamqp.framing.definitions.BasicContentPropertyList
- :members:
- :undoc-members:
-
-
-Take care, as :class:`~coolamqp.objects.MessageProperties` will hash the
-keys found and store it within non-GCable memory. So each "variant" of message
-properties encountered will be compiled as a separate class.
-
-Who am I talking to?
---------------------
-
-:class:`coolamqp.clustering.Cluster` has a nice property, that will return None until the connection is established.
-If it is, it will return something like this:
-
-.. autoclass:: coolamqp.objects.ServerProperties
- :members:
diff --git a/docs/index.rst b/docs/index.rst
index fbdf888..170b4c0 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -10,10 +10,10 @@ Welcome to CoolAMQP's documentation!
tutorials
how-to-guide
caveats
- frames
- basics
tracing
advanced
+ reference
+ frames
Quick FAQ
=========
--
GitLab