diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000000000000000000000000000000000000..1e246be1ed6566ddc482f5192295333f7d78fa21 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,10 @@ +version: 2 +build: + os: ubuntu-22.04 + tools: + python: "3.9" +sphinx: + configuration: docs/conf.py +python: + install: + - requirements: docs/requirements.txt diff --git a/docs/basics.rst b/docs/basics.rst index 5f80ace9385f7d00a28519559c4a731bfd1de55c..76b9fe83a39f124b31ac427f20334dcb21f49508 100644 --- a/docs/basics.rst +++ b/docs/basics.rst @@ -18,3 +18,24 @@ 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 +entire object (keys and values) and store it within non-GCable memory. + +This is done in order to facilitate reuse and speed/memory consumption. +If you're looking forward to shipping each message with different properties, +please wait until #51_ is fixed. + +.. _#51: https://github.com/smok-serwis/coolamqp/issues/51 +