openstack/zaqar
Code Issues Proposed changes

Adds the API reference to the devs guide

Browse Source 
This fix adds the detailed API reference to the developers guide
as it's done in major projects in the stack.

It also fix Sphinx warning and errors and adds a .rst files
generator to easily update the api reference in the future.

Plus, it includes an index for API, modules and search.

Co-Authored-By: Flavio Percoco <fpercoco@redhat.com>

Change-Id: If42121c9e8e852785cb2db3aa5d6895223b9d604
This commit is contained in:
Victoria Martínez de la Cruz 2014-08-22 18:26:06 -03:00
parent e448ddb5e0
commit 99d49dd358
114 changed files with 1047 additions and 126 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

97
doc/source/api/autoindex.rst Normal file
View File

@ -0,0 +1,97 @@
.. toctree::
:maxdepth: 1
zaqar.cmd.gc.rst
zaqar.cmd.server.rst
zaqar.common.access.rst
zaqar.common.api.rst
zaqar.common.cli.rst
zaqar.common.decorators.rst
zaqar.common.errors.rst
zaqar.common.pipeline.rst
zaqar.common.request.rst
zaqar.common.response.rst
zaqar.common.schemas.flavors.rst
zaqar.common.schemas.pools.rst
zaqar.common.storage.select.rst
zaqar.common.transport.wsgi.helpers.rst
zaqar.common.utils.rst
zaqar.i18n.rst
zaqar.openstack.common.cache._backends.memory.rst
zaqar.openstack.common.cache.backends.rst
zaqar.openstack.common.cache.cache.rst
zaqar.openstack.common.config.generator.rst
zaqar.openstack.common.excutils.rst
zaqar.openstack.common.fileutils.rst
zaqar.openstack.common.gettextutils.rst
zaqar.openstack.common.importutils.rst
zaqar.openstack.common.jsonutils.rst
zaqar.openstack.common.local.rst
zaqar.openstack.common.lockutils.rst
zaqar.openstack.common.log.rst
zaqar.openstack.common.strutils.rst
zaqar.openstack.common.timeutils.rst
zaqar.queues.api.v1_1.request.rst
zaqar.queues.api.v1_1.response.rst
zaqar.queues.api.v1.request.rst
zaqar.queues.api.v1.response.rst
zaqar.queues.bootstrap.rst
zaqar.queues.storage.base.rst
zaqar.queues.storage.errors.rst
zaqar.queues.storage.mongodb.catalogue.rst
zaqar.queues.storage.mongodb.claims.rst
zaqar.queues.storage.mongodb.controllers.rst
zaqar.queues.storage.mongodb.driver.rst
zaqar.queues.storage.mongodb.flavors.rst
zaqar.queues.storage.mongodb.messages.rst
zaqar.queues.storage.mongodb.options.rst
zaqar.queues.storage.mongodb.pools.rst
zaqar.queues.storage.mongodb.queues.rst
zaqar.queues.storage.mongodb.utils.rst
zaqar.queues.storage.pipeline.rst
zaqar.queues.storage.pooling.rst
zaqar.queues.storage.redis.claims.rst
zaqar.queues.storage.redis.controllers.rst
zaqar.queues.storage.redis.driver.rst
zaqar.queues.storage.redis.messages.rst
zaqar.queues.storage.redis.models.rst
zaqar.queues.storage.redis.options.rst
zaqar.queues.storage.redis.queues.rst
zaqar.queues.storage.redis.utils.rst
zaqar.queues.storage.sqlalchemy.catalogue.rst
zaqar.queues.storage.sqlalchemy.claims.rst
zaqar.queues.storage.sqlalchemy.controllers.rst
zaqar.queues.storage.sqlalchemy.driver.rst
zaqar.queues.storage.sqlalchemy.messages.rst
zaqar.queues.storage.sqlalchemy.options.rst
zaqar.queues.storage.sqlalchemy.pools.rst
zaqar.queues.storage.sqlalchemy.queues.rst
zaqar.queues.storage.sqlalchemy.tables.rst
zaqar.queues.storage.sqlalchemy.utils.rst
zaqar.queues.storage.utils.rst
zaqar.queues.transport.auth.rst
zaqar.queues.transport.base.rst
zaqar.queues.transport.utils.rst
zaqar.queues.transport.validation.rst
zaqar.queues.transport.wsgi.app.rst
zaqar.queues.transport.wsgi.driver.rst
zaqar.queues.transport.wsgi.errors.rst
zaqar.queues.transport.wsgi.utils.rst
zaqar.queues.transport.wsgi.v1_0.claims.rst
zaqar.queues.transport.wsgi.v1_0.health.rst
zaqar.queues.transport.wsgi.v1_0.homedoc.rst
zaqar.queues.transport.wsgi.v1_0.messages.rst
zaqar.queues.transport.wsgi.v1_0.metadata.rst
zaqar.queues.transport.wsgi.v1_0.pools.rst
zaqar.queues.transport.wsgi.v1_0.queues.rst
zaqar.queues.transport.wsgi.v1_0.stats.rst
zaqar.queues.transport.wsgi.v1_1.claims.rst
zaqar.queues.transport.wsgi.v1_1.flavors.rst
zaqar.queues.transport.wsgi.v1_1.health.rst
zaqar.queues.transport.wsgi.v1_1.homedoc.rst
zaqar.queues.transport.wsgi.v1_1.messages.rst
zaqar.queues.transport.wsgi.v1_1.ping.rst
zaqar.queues.transport.wsgi.v1_1.pools.rst
zaqar.queues.transport.wsgi.v1_1.queues.rst
zaqar.queues.transport.wsgi.v1_1.stats.rst
zaqar.version.rst

7
doc/source/api/zaqar.cmd.gc.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.cmd.gc` module
===============================
.. automodule:: zaqar.cmd.gc
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.cmd.server.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.cmd.server` module
===================================
.. automodule:: zaqar.cmd.server
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.common.access.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.common.access` module
======================================
.. automodule:: zaqar.common.access
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.common.api.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.common.api` module
===================================
.. automodule:: zaqar.common.api
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.common.cli.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.common.cli` module
===================================
.. automodule:: zaqar.common.cli
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.common.decorators.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.common.decorators` module
==========================================
.. automodule:: zaqar.common.decorators
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.common.errors.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.common.errors` module
======================================
.. automodule:: zaqar.common.errors
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.common.pipeline.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.common.pipeline` module
========================================
.. automodule:: zaqar.common.pipeline
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.common.request.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.common.request` module
=======================================
.. automodule:: zaqar.common.request
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.common.response.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.common.response` module
========================================
.. automodule:: zaqar.common.response
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.common.schemas.flavors.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.common.schemas.flavors` module
===============================================
.. automodule:: zaqar.common.schemas.flavors
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.common.schemas.pools.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.common.schemas.pools` module
=============================================
.. automodule:: zaqar.common.schemas.pools
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.common.storage.select.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.common.storage.select` module
==============================================
.. automodule:: zaqar.common.storage.select
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.common.transport.wsgi.helpers.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.common.transport.wsgi.helpers` module
======================================================
.. automodule:: zaqar.common.transport.wsgi.helpers
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.common.utils.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.common.utils` module
=====================================
.. automodule:: zaqar.common.utils
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.i18n.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.i18n` module
=============================
.. automodule:: zaqar.i18n
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.openstack.common.cache._backends.memory.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.openstack.common.cache._backends.memory` module
================================================================
.. automodule:: zaqar.openstack.common.cache._backends.memory
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.openstack.common.cache.backends.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.openstack.common.cache.backends` module
========================================================
.. automodule:: zaqar.openstack.common.cache.backends
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.openstack.common.cache.cache.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.openstack.common.cache.cache` module
=====================================================
.. automodule:: zaqar.openstack.common.cache.cache
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.openstack.common.config.generator.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.openstack.common.config.generator` module
==========================================================
.. automodule:: zaqar.openstack.common.config.generator
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.openstack.common.excutils.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.openstack.common.excutils` module
==================================================
.. automodule:: zaqar.openstack.common.excutils
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.openstack.common.fileutils.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.openstack.common.fileutils` module
===================================================
.. automodule:: zaqar.openstack.common.fileutils
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.openstack.common.gettextutils.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.openstack.common.gettextutils` module
======================================================
.. automodule:: zaqar.openstack.common.gettextutils
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.openstack.common.importutils.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.openstack.common.importutils` module
=====================================================
.. automodule:: zaqar.openstack.common.importutils
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.openstack.common.jsonutils.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.openstack.common.jsonutils` module
===================================================
.. automodule:: zaqar.openstack.common.jsonutils
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.openstack.common.local.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.openstack.common.local` module
===============================================
.. automodule:: zaqar.openstack.common.local
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.openstack.common.lockutils.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.openstack.common.lockutils` module
===================================================
.. automodule:: zaqar.openstack.common.lockutils
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.openstack.common.log.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.openstack.common.log` module
=============================================
.. automodule:: zaqar.openstack.common.log
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.openstack.common.strutils.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.openstack.common.strutils` module
==================================================
.. automodule:: zaqar.openstack.common.strutils
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.openstack.common.timeutils.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.openstack.common.timeutils` module
===================================================
.. automodule:: zaqar.openstack.common.timeutils
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.api.v1.request.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.api.v1.request` module
==============================================
.. automodule:: zaqar.queues.api.v1.request
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.api.v1.response.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.api.v1.response` module
===============================================
.. automodule:: zaqar.queues.api.v1.response
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.api.v1_1.request.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.api.v1_1.request` module
================================================
.. automodule:: zaqar.queues.api.v1_1.request
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.api.v1_1.response.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.api.v1_1.response` module
=================================================
.. automodule:: zaqar.queues.api.v1_1.response
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.bootstrap.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.bootstrap` module
=========================================
.. automodule:: zaqar.queues.bootstrap
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.base.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.base` module
============================================
.. automodule:: zaqar.queues.storage.base
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.errors.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.errors` module
==============================================
.. automodule:: zaqar.queues.storage.errors
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.mongodb.catalogue.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.mongodb.catalogue` module
=========================================================
.. automodule:: zaqar.queues.storage.mongodb.catalogue
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.mongodb.claims.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.mongodb.claims` module
======================================================
.. automodule:: zaqar.queues.storage.mongodb.claims
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.mongodb.controllers.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.mongodb.controllers` module
===========================================================
.. automodule:: zaqar.queues.storage.mongodb.controllers
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.mongodb.driver.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.mongodb.driver` module
======================================================
.. automodule:: zaqar.queues.storage.mongodb.driver
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.mongodb.flavors.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.mongodb.flavors` module
=======================================================
.. automodule:: zaqar.queues.storage.mongodb.flavors
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.mongodb.messages.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.mongodb.messages` module
========================================================
.. automodule:: zaqar.queues.storage.mongodb.messages
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.mongodb.options.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.mongodb.options` module
=======================================================
.. automodule:: zaqar.queues.storage.mongodb.options
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.mongodb.pools.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.mongodb.pools` module
=====================================================
.. automodule:: zaqar.queues.storage.mongodb.pools
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.mongodb.queues.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.mongodb.queues` module
======================================================
.. automodule:: zaqar.queues.storage.mongodb.queues
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.mongodb.utils.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.mongodb.utils` module
=====================================================
.. automodule:: zaqar.queues.storage.mongodb.utils
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.pipeline.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.pipeline` module
================================================
.. automodule:: zaqar.queues.storage.pipeline
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.pooling.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.pooling` module
===============================================
.. automodule:: zaqar.queues.storage.pooling
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.redis.claims.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.redis.claims` module
====================================================
.. automodule:: zaqar.queues.storage.redis.claims
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.redis.controllers.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.redis.controllers` module
=========================================================
.. automodule:: zaqar.queues.storage.redis.controllers
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.redis.driver.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.redis.driver` module
====================================================
.. automodule:: zaqar.queues.storage.redis.driver
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.redis.messages.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.redis.messages` module
======================================================
.. automodule:: zaqar.queues.storage.redis.messages
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.redis.models.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.redis.models` module
====================================================
.. automodule:: zaqar.queues.storage.redis.models
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.redis.options.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.redis.options` module
=====================================================
.. automodule:: zaqar.queues.storage.redis.options
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.redis.queues.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.redis.queues` module
====================================================
.. automodule:: zaqar.queues.storage.redis.queues
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.redis.utils.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.redis.utils` module
===================================================
.. automodule:: zaqar.queues.storage.redis.utils
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.sqlalchemy.catalogue.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.sqlalchemy.catalogue` module
============================================================
.. automodule:: zaqar.queues.storage.sqlalchemy.catalogue
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.sqlalchemy.claims.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.sqlalchemy.claims` module
=========================================================
.. automodule:: zaqar.queues.storage.sqlalchemy.claims
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.sqlalchemy.controllers.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.sqlalchemy.controllers` module
==============================================================
.. automodule:: zaqar.queues.storage.sqlalchemy.controllers
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.sqlalchemy.driver.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.sqlalchemy.driver` module
=========================================================
.. automodule:: zaqar.queues.storage.sqlalchemy.driver
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.sqlalchemy.messages.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.sqlalchemy.messages` module
===========================================================
.. automodule:: zaqar.queues.storage.sqlalchemy.messages
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.sqlalchemy.options.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.sqlalchemy.options` module
==========================================================
.. automodule:: zaqar.queues.storage.sqlalchemy.options
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.sqlalchemy.pools.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.sqlalchemy.pools` module
========================================================
.. automodule:: zaqar.queues.storage.sqlalchemy.pools
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.sqlalchemy.queues.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.sqlalchemy.queues` module
=========================================================
.. automodule:: zaqar.queues.storage.sqlalchemy.queues
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.sqlalchemy.tables.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.sqlalchemy.tables` module
=========================================================
.. automodule:: zaqar.queues.storage.sqlalchemy.tables
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.sqlalchemy.utils.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.sqlalchemy.utils` module
========================================================
.. automodule:: zaqar.queues.storage.sqlalchemy.utils
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.storage.utils.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.storage.utils` module
=============================================
.. automodule:: zaqar.queues.storage.utils
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.transport.auth.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.transport.auth` module
==============================================
.. automodule:: zaqar.queues.transport.auth
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.transport.base.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.transport.base` module
==============================================
.. automodule:: zaqar.queues.transport.base
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.transport.utils.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.transport.utils` module
===============================================
.. automodule:: zaqar.queues.transport.utils
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.transport.validation.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.transport.validation` module
====================================================
.. automodule:: zaqar.queues.transport.validation
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.transport.wsgi.app.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.transport.wsgi.app` module
==================================================
.. automodule:: zaqar.queues.transport.wsgi.app
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.transport.wsgi.driver.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.transport.wsgi.driver` module
=====================================================
.. automodule:: zaqar.queues.transport.wsgi.driver
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.transport.wsgi.errors.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.transport.wsgi.errors` module
=====================================================
.. automodule:: zaqar.queues.transport.wsgi.errors
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.transport.wsgi.utils.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.transport.wsgi.utils` module
====================================================
.. automodule:: zaqar.queues.transport.wsgi.utils
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.transport.wsgi.v1_0.claims.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.transport.wsgi.v1_0.claims` module
==========================================================
.. automodule:: zaqar.queues.transport.wsgi.v1_0.claims
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.transport.wsgi.v1_0.health.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.transport.wsgi.v1_0.health` module
==========================================================
.. automodule:: zaqar.queues.transport.wsgi.v1_0.health
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.transport.wsgi.v1_0.homedoc.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.transport.wsgi.v1_0.homedoc` module
===========================================================
.. automodule:: zaqar.queues.transport.wsgi.v1_0.homedoc
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.transport.wsgi.v1_0.messages.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.transport.wsgi.v1_0.messages` module
============================================================
.. automodule:: zaqar.queues.transport.wsgi.v1_0.messages
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.transport.wsgi.v1_0.metadata.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.transport.wsgi.v1_0.metadata` module
============================================================
.. automodule:: zaqar.queues.transport.wsgi.v1_0.metadata
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.transport.wsgi.v1_0.pools.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.transport.wsgi.v1_0.pools` module
=========================================================
.. automodule:: zaqar.queues.transport.wsgi.v1_0.pools
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.transport.wsgi.v1_0.queues.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.transport.wsgi.v1_0.queues` module
==========================================================
.. automodule:: zaqar.queues.transport.wsgi.v1_0.queues
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.transport.wsgi.v1_0.stats.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.transport.wsgi.v1_0.stats` module
=========================================================
.. automodule:: zaqar.queues.transport.wsgi.v1_0.stats
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.transport.wsgi.v1_1.claims.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.transport.wsgi.v1_1.claims` module
==========================================================
.. automodule:: zaqar.queues.transport.wsgi.v1_1.claims
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.transport.wsgi.v1_1.flavors.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.transport.wsgi.v1_1.flavors` module
===========================================================
.. automodule:: zaqar.queues.transport.wsgi.v1_1.flavors
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.transport.wsgi.v1_1.health.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.transport.wsgi.v1_1.health` module
==========================================================
.. automodule:: zaqar.queues.transport.wsgi.v1_1.health
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.transport.wsgi.v1_1.homedoc.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.transport.wsgi.v1_1.homedoc` module
===========================================================
.. automodule:: zaqar.queues.transport.wsgi.v1_1.homedoc
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.transport.wsgi.v1_1.messages.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.transport.wsgi.v1_1.messages` module
============================================================
.. automodule:: zaqar.queues.transport.wsgi.v1_1.messages
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.transport.wsgi.v1_1.ping.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.transport.wsgi.v1_1.ping` module
========================================================
.. automodule:: zaqar.queues.transport.wsgi.v1_1.ping
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.transport.wsgi.v1_1.pools.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.transport.wsgi.v1_1.pools` module
=========================================================
.. automodule:: zaqar.queues.transport.wsgi.v1_1.pools
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.transport.wsgi.v1_1.queues.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.transport.wsgi.v1_1.queues` module
==========================================================
.. automodule:: zaqar.queues.transport.wsgi.v1_1.queues
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.queues.transport.wsgi.v1_1.stats.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.queues.transport.wsgi.v1_1.stats` module
=========================================================
.. automodule:: zaqar.queues.transport.wsgi.v1_1.stats
:members:
:undoc-members:
:show-inheritance:

7
doc/source/api/zaqar.version.rst Normal file
View File

@ -0,0 +1,7 @@
The :mod:`zaqar.version` module
================================
.. automodule:: zaqar.version
:members:
:undoc-members:
:show-inheritance:

15
doc/source/index.rst
View File

@ -117,6 +117,14 @@ Other resources
gerrit gerrit
jenkins jenkins
API reference
=============
.. toctree::
:maxdepth: 3
api/autoindex
Modules reference Modules reference
================= =================
@ -125,3 +133,10 @@ Modules reference
transport transport
storage storage
Indices and tables
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

5
doc/source/storage.rst
View File

@ -5,16 +5,21 @@ Storage
.. currentmodule:: zaqar.queues.storage.base .. currentmodule:: zaqar.queues.storage.base
.. autoclass:: DataDriverBase .. autoclass:: DataDriverBase
:noindex:
:members: :members:
.. autoclass:: ControlDriverBase .. autoclass:: ControlDriverBase
:noindex:
:members: :members:
.. autoclass:: Queue .. autoclass:: Queue
:noindex:
:members: :members:
.. autoclass:: Message .. autoclass:: Message
:noindex:
:members: :members:
.. autoclass:: Claim .. autoclass:: Claim
:noindex:
:members: :members:

1
doc/source/transport.rst
View File

@ -5,4 +5,5 @@ Transport
.. currentmodule:: zaqar.queues.transport.base .. currentmodule:: zaqar.queues.transport.base
.. autoclass:: DriverBase .. autoclass:: DriverBase
:noindex:
:members: :members:

20
tools/doc/find_autodoc_modules.sh Executable file
View File

@ -0,0 +1,20 @@
#!/bin/bash
ZAQAR_DIR='../../zaqar/' # include trailing slash
DOCS_DIR='source'
modules=''
for x in `find ${ZAQAR_DIR} -name '*.py' | grep -v zaqar/tests | grep -v zaqar/bench`; do
if [ `basename ${x} .py` == "__init__" ] ; then
continue
fi
relative=zaqar.`echo ${x} | sed -e 's$^'${ZAQAR_DIR}'$$' -e 's/.py$//' -e 's$/$.$g'`
modules="${modules} ${relative}"
done
for mod in ${modules} ; do
if [ ! -f "${DOCS_DIR}/${mod}.rst" ];
then
echo ${mod}
fi
done

46
tools/doc/generate_autodoc_index.sh Executable file
View File

@ -0,0 +1,46 @@
#!/bin/sh
SOURCEDIR=../../doc/source/api
if [ ! -d ${SOURCEDIR} ] ; then
mkdir -p ${SOURCEDIR}
fi
for x in `./find_autodoc_modules.sh`;
do
echo "Generating ${SOURCEDIR}/${x}.rst"
echo "${SOURCEDIR}/${x}.rst" >> .autogenerated
heading="The :mod:\`${x}\` module"
# Figure out how long the heading is
# and make sure to emit that many '=' under
# it to avoid heading format errors
# in Sphinx.
heading_len=$(echo "$heading" | wc -c)
underline=$(head -c $heading_len < /dev/zero | tr '\0' '=')
( cat <<EOF
${heading}
${underline}
.. automodule:: ${x}
:members:
:undoc-members:
:show-inheritance:
EOF
) > ${SOURCEDIR}/${x}.rst
done
if [ ! -f ${SOURCEDIR}/autoindex.rst ] ; then
cat > ${SOURCEDIR}/autoindex.rst <<EOF
.. toctree::
:maxdepth: 1
EOF
for f in `cat .autogenerated | sort` ; do
relative=`echo ${f} | sed -e 's$^'${SOURCEDIR}'/$$'`
echo " ${relative}" >> ${SOURCEDIR}/autoindex.rst
done
echo ${SOURCEDIR}/autoindex.rst >> .autogenerated
fi

Some files were not shown because too many files have changed in this diff Show More