openstack/zaqar
Code Issues Proposed changes

Add dev docs for transport/storage dirvers

Browse Source 
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
This commit is contained in:
Flavio Percoco 2014-08-22 15:50:51 +02:00
parent fb23e719a2
commit 1e220fcf07
3 changed files with 37 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/source/index.rst
View File

@ -96,3 +96,12 @@ Running and writing tests
running_tests
test_suite
Modules Reference
=================
.. toctree::
:maxdepth: 1
transport
storage

20
doc/source/storage.rst Normal file
View File

@ -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:

8
doc/source/transport.rst Normal file
View File

@ -0,0 +1,8 @@
---------
Transport
---------
.. currentmodule:: zaqar.queues.transport.base
.. autoclass:: DriverBase
:members: