From 1e220fcf0793477d6880de6f64311a9ef3a1876b Mon Sep 17 00:00:00 2001 From: Flavio Percoco Date: Fri, 22 Aug 2014 15:50:51 +0200 Subject: [PATCH] Add dev docs for transport/storage dirvers This patch adds RSTs for both the transport and the storage layers. This docs contain all the information found on the base drivers, which describes the API of both layers. Change-Id: I0007b81e902edf818e5c47dbc156795507afea75 --- doc/source/index.rst | 9 +++++++++ doc/source/storage.rst | 20 ++++++++++++++++++++ doc/source/transport.rst | 8 ++++++++ 3 files changed, 37 insertions(+) create mode 100644 doc/source/storage.rst create mode 100644 doc/source/transport.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index c4de67b11..5aedf8d5c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -96,3 +96,12 @@ Running and writing tests running_tests test_suite + +Modules Reference +================= + +.. toctree:: + :maxdepth: 1 + + transport + storage diff --git a/doc/source/storage.rst b/doc/source/storage.rst new file mode 100644 index 000000000..4260f9690 --- /dev/null +++ b/doc/source/storage.rst @@ -0,0 +1,20 @@ +------- +Storage +------- + +.. currentmodule:: zaqar.queues.storage.base + +.. autoclass:: DataDriverBase + :members: + +.. autoclass:: ControlDriverBase + :members: + +.. autoclass:: Queue + :members: + +.. autoclass:: Message + :members: + +.. autoclass:: Claim + :members: diff --git a/doc/source/transport.rst b/doc/source/transport.rst new file mode 100644 index 000000000..83a302967 --- /dev/null +++ b/doc/source/transport.rst @@ -0,0 +1,8 @@ +--------- +Transport +--------- + +.. currentmodule:: zaqar.queues.transport.base + +.. autoclass:: DriverBase + :members: