diff --git a/docs/basics.rst b/docs/basics.rst deleted file mode 100644 index 1531b9beda10a3a89a4b7a9b36089d217a0843fb..0000000000000000000000000000000000000000 --- 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 fbdf8887789969e9e1706c78f9abe3bd9131158d..170b4c031d575779e6495e875d9b161966b552e9 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 =========