diff --git a/README.rst b/README.rst index 159ec9e5a..51737fb00 100644 --- a/README.rst +++ b/README.rst @@ -34,10 +34,10 @@ The API v2.0 (stable) specification and documentation are available at: https://wiki.openstack.org/wiki/Zaqar/specs/api/v2.0 -Zaqar Contributor Documentation, the source of which is in ``doc/source/``, is +Zaqar's Documentation, the source of which is in ``doc/source/``, is available at: - https://docs.openstack.org/developer/zaqar/ + https://docs.openstack.org/zaqar/latest Contributors are encouraged to join IRC (``#openstack-zaqar`` channel on ``irc.freenode.net``): @@ -46,11 +46,11 @@ Contributors are encouraged to join IRC (``#openstack-zaqar`` channel on Information on how to run unit and functional tests is available at: - https://docs.openstack.org/developer/zaqar/running_tests.html + https://docs.openstack.org/zaqar/admin/running_tests.html Information on how to run benchmarking tool is available at: - https://docs.openstack.org/developer/zaqar/running_benchmark.html + https://docs.openstack.org/zaqar/admin/running_benchmark.html Using Zaqar ----------- @@ -66,7 +66,7 @@ Using Zaqar in development environment: The instruction is available at: - https://docs.openstack.org/developer/zaqar/devref/development.environment.html + https://docs.openstack.org/zaqar/contributor/development.environment.html This will allow you to run local Zaqar server with MongoDB as database. diff --git a/doc/source/CORS.rst b/doc/source/admin/CORS.rst similarity index 100% rename from doc/source/CORS.rst rename to doc/source/admin/CORS.rst diff --git a/doc/source/OSprofiler.rst b/doc/source/admin/OSprofiler.rst similarity index 100% rename from doc/source/OSprofiler.rst rename to doc/source/admin/OSprofiler.rst diff --git a/doc/source/devref/gmr.rst b/doc/source/admin/gmr.rst similarity index 100% rename from doc/source/devref/gmr.rst rename to doc/source/admin/gmr.rst diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst new file mode 100644 index 000000000..8f0244efc --- /dev/null +++ b/doc/source/admin/index.rst @@ -0,0 +1,13 @@ +==================== +Administration Guide +==================== + +.. toctree:: + :maxdepth: 2 + + subscription_confirm + OSprofiler + CORS + gmr + running_benchmark + writing_pipeline_stages diff --git a/doc/source/running_benchmark.rst b/doc/source/admin/running_benchmark.rst similarity index 99% rename from doc/source/running_benchmark.rst rename to doc/source/admin/running_benchmark.rst index 9343decdc..08ff8c254 100644 --- a/doc/source/running_benchmark.rst +++ b/doc/source/admin/running_benchmark.rst @@ -30,7 +30,7 @@ Usage For example, you can setup Zaqar in development environment. - See :doc:`devref/development.environment`. + See :doc:`../contributor/development.environment`. 2. In your terminal cd into your local Zaqar repo and install additional requirements: diff --git a/doc/source/subscription_confirm.rst b/doc/source/admin/subscription_confirm.rst similarity index 99% rename from doc/source/subscription_confirm.rst rename to doc/source/admin/subscription_confirm.rst index 50c0bd56f..54e3160d9 100644 --- a/doc/source/subscription_confirm.rst +++ b/doc/source/admin/subscription_confirm.rst @@ -222,11 +222,14 @@ Email 1. For the email confirmation way, also need to set the config option "external_confirmation_url", "subscription_confirmation_email_template" and "unsubscribe_confirmation_email_template". + The confirmation page url that will be used in email subscription confirmation before notification, this page is not hosted in Zaqar server, user should build their own web service to provide this web page. + The subscription_confirmation_email_template let user to customize the subscription confirmation email content, including topic, body and sender. + The unsubscribe_confirmation_email_template let user to customize the unsubscribe confirmation email content, including topic, body and sender too:: diff --git a/doc/source/writing_pipeline_stages.rst b/doc/source/admin/writing_pipeline_stages.rst similarity index 100% rename from doc/source/writing_pipeline_stages.rst rename to doc/source/admin/writing_pipeline_stages.rst diff --git a/doc/source/api/autoindex.rst b/doc/source/api/autoindex.rst deleted file mode 100644 index e2a3792cc..000000000 --- a/doc/source/api/autoindex.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. toctree:: - :glob: - :maxdepth: 1 - - * diff --git a/doc/source/api/zaqar.api.handler.rst b/doc/source/api/zaqar.api.handler.rst deleted file mode 100644 index 529496268..000000000 --- a/doc/source/api/zaqar.api.handler.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.api.handler` module -==================================== - -.. automodule:: zaqar.api.handler - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.api.v1.request.rst b/doc/source/api/zaqar.api.v1.request.rst deleted file mode 100644 index ca7ad8b3c..000000000 --- a/doc/source/api/zaqar.api.v1.request.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.api.v1.request` module -======================================= - -.. automodule:: zaqar.api.v1.request - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.api.v1.response.rst b/doc/source/api/zaqar.api.v1.response.rst deleted file mode 100644 index 6bf7552e7..000000000 --- a/doc/source/api/zaqar.api.v1.response.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.api.v1.response` module -======================================== - -.. automodule:: zaqar.api.v1.response - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.api.v1_1.request.rst b/doc/source/api/zaqar.api.v1_1.request.rst deleted file mode 100644 index 21bb71a11..000000000 --- a/doc/source/api/zaqar.api.v1_1.request.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.api.v1_1.request` module -========================================= - -.. automodule:: zaqar.api.v1_1.request - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.api.v1_1.response.rst b/doc/source/api/zaqar.api.v1_1.response.rst deleted file mode 100644 index a05cb6f27..000000000 --- a/doc/source/api/zaqar.api.v1_1.response.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.api.v1_1.response` module -========================================== - -.. automodule:: zaqar.api.v1_1.response - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.api.v2.endpoints.rst b/doc/source/api/zaqar.api.v2.endpoints.rst deleted file mode 100644 index 14289007d..000000000 --- a/doc/source/api/zaqar.api.v2.endpoints.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.api.v2.endpoints` module -========================================= - -.. automodule:: zaqar.api.v2.endpoints - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.api.v2.request.rst b/doc/source/api/zaqar.api.v2.request.rst deleted file mode 100644 index cda464819..000000000 --- a/doc/source/api/zaqar.api.v2.request.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.api.v2.request` module -======================================= - -.. automodule:: zaqar.api.v2.request - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.api.v2.response.rst b/doc/source/api/zaqar.api.v2.response.rst deleted file mode 100644 index 00749f5dc..000000000 --- a/doc/source/api/zaqar.api.v2.response.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.api.v2.response` module -======================================== - -.. automodule:: zaqar.api.v2.response - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.bootstrap.rst b/doc/source/api/zaqar.bootstrap.rst deleted file mode 100644 index 568b0a9f6..000000000 --- a/doc/source/api/zaqar.bootstrap.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.bootstrap` module -================================== - -.. automodule:: zaqar.bootstrap - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.cmd.gc.rst b/doc/source/api/zaqar.cmd.gc.rst deleted file mode 100644 index 3612a8a74..000000000 --- a/doc/source/api/zaqar.cmd.gc.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.cmd.gc` module -=============================== - -.. automodule:: zaqar.cmd.gc - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.cmd.server.rst b/doc/source/api/zaqar.cmd.server.rst deleted file mode 100644 index 30b71b9c5..000000000 --- a/doc/source/api/zaqar.cmd.server.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.cmd.server` module -=================================== - -.. automodule:: zaqar.cmd.server - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.common.access.rst b/doc/source/api/zaqar.common.access.rst deleted file mode 100644 index 9a663364a..000000000 --- a/doc/source/api/zaqar.common.access.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.common.access` module -====================================== - -.. automodule:: zaqar.common.access - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.common.api.api.rst b/doc/source/api/zaqar.common.api.api.rst deleted file mode 100644 index 6fc913da0..000000000 --- a/doc/source/api/zaqar.common.api.api.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.common.api.api` module -======================================= - -.. automodule:: zaqar.common.api.api - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.common.api.errors.rst b/doc/source/api/zaqar.common.api.errors.rst deleted file mode 100644 index f48e8643a..000000000 --- a/doc/source/api/zaqar.common.api.errors.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.common.api.errors` module -========================================== - -.. automodule:: zaqar.common.api.errors - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.common.api.request.rst b/doc/source/api/zaqar.common.api.request.rst deleted file mode 100644 index b371ed95a..000000000 --- a/doc/source/api/zaqar.common.api.request.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.common.api.request` module -=========================================== - -.. automodule:: zaqar.common.api.request - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.common.api.response.rst b/doc/source/api/zaqar.common.api.response.rst deleted file mode 100644 index 383563d3c..000000000 --- a/doc/source/api/zaqar.common.api.response.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.common.api.response` module -============================================ - -.. automodule:: zaqar.common.api.response - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.common.api.schemas.flavors.rst b/doc/source/api/zaqar.common.api.schemas.flavors.rst deleted file mode 100644 index a269ae58b..000000000 --- a/doc/source/api/zaqar.common.api.schemas.flavors.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.common.api.schemas.flavors` module -=================================================== - -.. automodule:: zaqar.common.api.schemas.flavors - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.common.api.schemas.pools.rst b/doc/source/api/zaqar.common.api.schemas.pools.rst deleted file mode 100644 index 2dc5947dd..000000000 --- a/doc/source/api/zaqar.common.api.schemas.pools.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.common.api.schemas.pools` module -================================================= - -.. automodule:: zaqar.common.api.schemas.pools - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.common.api.utils.rst b/doc/source/api/zaqar.common.api.utils.rst deleted file mode 100644 index 85fe9309b..000000000 --- a/doc/source/api/zaqar.common.api.utils.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.common.api.utils` module -========================================= - -.. automodule:: zaqar.common.api.utils - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.common.cli.rst b/doc/source/api/zaqar.common.cli.rst deleted file mode 100644 index 5cc1d8875..000000000 --- a/doc/source/api/zaqar.common.cli.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.common.cli` module -=================================== - -.. automodule:: zaqar.common.cli - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.common.configs.rst b/doc/source/api/zaqar.common.configs.rst deleted file mode 100644 index e73c3d2e8..000000000 --- a/doc/source/api/zaqar.common.configs.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.common.configs` module -======================================= - -.. automodule:: zaqar.common.configs - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.common.decorators.rst b/doc/source/api/zaqar.common.decorators.rst deleted file mode 100644 index 38ba1b7e0..000000000 --- a/doc/source/api/zaqar.common.decorators.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.common.decorators` module -========================================== - -.. automodule:: zaqar.common.decorators - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.common.errors.rst b/doc/source/api/zaqar.common.errors.rst deleted file mode 100644 index 8a1e7349b..000000000 --- a/doc/source/api/zaqar.common.errors.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.common.errors` module -====================================== - -.. automodule:: zaqar.common.errors - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.common.pipeline.rst b/doc/source/api/zaqar.common.pipeline.rst deleted file mode 100644 index b2913de25..000000000 --- a/doc/source/api/zaqar.common.pipeline.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.common.pipeline` module -======================================== - -.. automodule:: zaqar.common.pipeline - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.common.storage.select.rst b/doc/source/api/zaqar.common.storage.select.rst deleted file mode 100644 index d12712e41..000000000 --- a/doc/source/api/zaqar.common.storage.select.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.common.storage.select` module -============================================== - -.. automodule:: zaqar.common.storage.select - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.common.transport.wsgi.helpers.rst b/doc/source/api/zaqar.common.transport.wsgi.helpers.rst deleted file mode 100644 index bf4ae0ebf..000000000 --- a/doc/source/api/zaqar.common.transport.wsgi.helpers.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.common.transport.wsgi.helpers` module -====================================================== - -.. automodule:: zaqar.common.transport.wsgi.helpers - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.common.urls.rst b/doc/source/api/zaqar.common.urls.rst deleted file mode 100644 index bf23b0499..000000000 --- a/doc/source/api/zaqar.common.urls.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.common.urls` module -==================================== - -.. automodule:: zaqar.common.urls - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.common.utils.rst b/doc/source/api/zaqar.common.utils.rst deleted file mode 100644 index af9fc3da8..000000000 --- a/doc/source/api/zaqar.common.utils.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.common.utils` module -===================================== - -.. automodule:: zaqar.common.utils - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.context.rst b/doc/source/api/zaqar.context.rst deleted file mode 100644 index 11b6aab09..000000000 --- a/doc/source/api/zaqar.context.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.context` module -================================ - -.. automodule:: zaqar.context - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.i18n.rst b/doc/source/api/zaqar.i18n.rst deleted file mode 100644 index 190d5be81..000000000 --- a/doc/source/api/zaqar.i18n.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.i18n` module -============================= - -.. automodule:: zaqar.i18n - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.notification.notifier.rst b/doc/source/api/zaqar.notification.notifier.rst deleted file mode 100644 index 8f29d9fdc..000000000 --- a/doc/source/api/zaqar.notification.notifier.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.notification.notifier` module -============================================== - -.. automodule:: zaqar.notification.notifier - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.notification.tasks.mailto.rst b/doc/source/api/zaqar.notification.tasks.mailto.rst deleted file mode 100644 index 2dd3cc7b2..000000000 --- a/doc/source/api/zaqar.notification.tasks.mailto.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.notification.tasks.mailto` module -================================================== - -.. automodule:: zaqar.notification.tasks.mailto - :members: - :undoc-members: - :show-inheritance: \ No newline at end of file diff --git a/doc/source/api/zaqar.notification.tasks.webhook.rst b/doc/source/api/zaqar.notification.tasks.webhook.rst deleted file mode 100644 index c3edbe7cc..000000000 --- a/doc/source/api/zaqar.notification.tasks.webhook.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.notification.tasks.webhook` module -================================================== - -.. automodule:: zaqar.notification.tasks.webhook - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.base.rst b/doc/source/api/zaqar.storage.base.rst deleted file mode 100644 index 78329d03a..000000000 --- a/doc/source/api/zaqar.storage.base.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.base` module -===================================== - -.. automodule:: zaqar.storage.base - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.errors.rst b/doc/source/api/zaqar.storage.errors.rst deleted file mode 100644 index dcd96d78c..000000000 --- a/doc/source/api/zaqar.storage.errors.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.errors` module -======================================= - -.. automodule:: zaqar.storage.errors - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.mongodb.catalogue.rst b/doc/source/api/zaqar.storage.mongodb.catalogue.rst deleted file mode 100644 index df797faf4..000000000 --- a/doc/source/api/zaqar.storage.mongodb.catalogue.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.mongodb.catalogue` module -================================================== - -.. automodule:: zaqar.storage.mongodb.catalogue - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.mongodb.claims.rst b/doc/source/api/zaqar.storage.mongodb.claims.rst deleted file mode 100644 index 406a6b147..000000000 --- a/doc/source/api/zaqar.storage.mongodb.claims.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.mongodb.claims` module -=============================================== - -.. automodule:: zaqar.storage.mongodb.claims - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.mongodb.controllers.rst b/doc/source/api/zaqar.storage.mongodb.controllers.rst deleted file mode 100644 index 93dddf6d1..000000000 --- a/doc/source/api/zaqar.storage.mongodb.controllers.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.mongodb.controllers` module -==================================================== - -.. automodule:: zaqar.storage.mongodb.controllers - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.mongodb.driver.rst b/doc/source/api/zaqar.storage.mongodb.driver.rst deleted file mode 100644 index bfe0b5703..000000000 --- a/doc/source/api/zaqar.storage.mongodb.driver.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.mongodb.driver` module -=============================================== - -.. automodule:: zaqar.storage.mongodb.driver - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.mongodb.flavors.rst b/doc/source/api/zaqar.storage.mongodb.flavors.rst deleted file mode 100644 index d9954958f..000000000 --- a/doc/source/api/zaqar.storage.mongodb.flavors.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.mongodb.flavors` module -================================================ - -.. automodule:: zaqar.storage.mongodb.flavors - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.mongodb.messages.rst b/doc/source/api/zaqar.storage.mongodb.messages.rst deleted file mode 100644 index 7a4a402bb..000000000 --- a/doc/source/api/zaqar.storage.mongodb.messages.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.mongodb.messages` module -================================================= - -.. automodule:: zaqar.storage.mongodb.messages - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.mongodb.options.rst b/doc/source/api/zaqar.storage.mongodb.options.rst deleted file mode 100644 index e757fee29..000000000 --- a/doc/source/api/zaqar.storage.mongodb.options.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.mongodb.options` module -================================================ - -.. automodule:: zaqar.storage.mongodb.options - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.mongodb.pools.rst b/doc/source/api/zaqar.storage.mongodb.pools.rst deleted file mode 100644 index f4fe9a997..000000000 --- a/doc/source/api/zaqar.storage.mongodb.pools.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.mongodb.pools` module -============================================== - -.. automodule:: zaqar.storage.mongodb.pools - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.mongodb.queues.rst b/doc/source/api/zaqar.storage.mongodb.queues.rst deleted file mode 100644 index 013deb356..000000000 --- a/doc/source/api/zaqar.storage.mongodb.queues.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.mongodb.queues` module -=============================================== - -.. automodule:: zaqar.storage.mongodb.queues - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.mongodb.subscriptions.rst b/doc/source/api/zaqar.storage.mongodb.subscriptions.rst deleted file mode 100644 index 6a15f3ffa..000000000 --- a/doc/source/api/zaqar.storage.mongodb.subscriptions.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.mongodb.subscriptions` module -====================================================== - -.. automodule:: zaqar.storage.mongodb.subscriptions - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.mongodb.utils.rst b/doc/source/api/zaqar.storage.mongodb.utils.rst deleted file mode 100644 index 477fbe5ac..000000000 --- a/doc/source/api/zaqar.storage.mongodb.utils.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.mongodb.utils` module -============================================== - -.. automodule:: zaqar.storage.mongodb.utils - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.pipeline.rst b/doc/source/api/zaqar.storage.pipeline.rst deleted file mode 100644 index 2c7572979..000000000 --- a/doc/source/api/zaqar.storage.pipeline.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.pipeline` module -========================================= - -.. automodule:: zaqar.storage.pipeline - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.pooling.rst b/doc/source/api/zaqar.storage.pooling.rst deleted file mode 100644 index f95e6160c..000000000 --- a/doc/source/api/zaqar.storage.pooling.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.pooling` module -======================================== - -.. automodule:: zaqar.storage.pooling - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.redis.claims.rst b/doc/source/api/zaqar.storage.redis.claims.rst deleted file mode 100644 index 6be259cac..000000000 --- a/doc/source/api/zaqar.storage.redis.claims.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.redis.claims` module -============================================= - -.. automodule:: zaqar.storage.redis.claims - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.redis.controllers.rst b/doc/source/api/zaqar.storage.redis.controllers.rst deleted file mode 100644 index 1d1db6856..000000000 --- a/doc/source/api/zaqar.storage.redis.controllers.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.redis.controllers` module -================================================== - -.. automodule:: zaqar.storage.redis.controllers - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.redis.driver.rst b/doc/source/api/zaqar.storage.redis.driver.rst deleted file mode 100644 index c1f4e723a..000000000 --- a/doc/source/api/zaqar.storage.redis.driver.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.redis.driver` module -============================================= - -.. automodule:: zaqar.storage.redis.driver - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.redis.messages.rst b/doc/source/api/zaqar.storage.redis.messages.rst deleted file mode 100644 index 4c0abd7a9..000000000 --- a/doc/source/api/zaqar.storage.redis.messages.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.redis.messages` module -=============================================== - -.. automodule:: zaqar.storage.redis.messages - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.redis.models.rst b/doc/source/api/zaqar.storage.redis.models.rst deleted file mode 100644 index 888a5f5fa..000000000 --- a/doc/source/api/zaqar.storage.redis.models.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.redis.models` module -============================================= - -.. automodule:: zaqar.storage.redis.models - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.redis.options.rst b/doc/source/api/zaqar.storage.redis.options.rst deleted file mode 100644 index 6ef022076..000000000 --- a/doc/source/api/zaqar.storage.redis.options.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.redis.options` module -============================================== - -.. automodule:: zaqar.storage.redis.options - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.redis.queues.rst b/doc/source/api/zaqar.storage.redis.queues.rst deleted file mode 100644 index 32ea9ffed..000000000 --- a/doc/source/api/zaqar.storage.redis.queues.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.redis.queues` module -============================================= - -.. automodule:: zaqar.storage.redis.queues - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.redis.scripting.rst b/doc/source/api/zaqar.storage.redis.scripting.rst deleted file mode 100644 index 02c71c878..000000000 --- a/doc/source/api/zaqar.storage.redis.scripting.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.redis.scripting` module -================================================ - -.. automodule:: zaqar.storage.redis.scripting - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.redis.subscriptions.rst b/doc/source/api/zaqar.storage.redis.subscriptions.rst deleted file mode 100644 index 712704d9c..000000000 --- a/doc/source/api/zaqar.storage.redis.subscriptions.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.redis.subscriptions` module -==================================================== - -.. automodule:: zaqar.storage.redis.subscriptions - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.redis.utils.rst b/doc/source/api/zaqar.storage.redis.utils.rst deleted file mode 100644 index a8855e818..000000000 --- a/doc/source/api/zaqar.storage.redis.utils.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.redis.utils` module -============================================ - -.. automodule:: zaqar.storage.redis.utils - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.sqlalchemy.catalogue.rst b/doc/source/api/zaqar.storage.sqlalchemy.catalogue.rst deleted file mode 100644 index 4c57d8b81..000000000 --- a/doc/source/api/zaqar.storage.sqlalchemy.catalogue.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.sqlalchemy.catalogue` module -===================================================== - -.. automodule:: zaqar.storage.sqlalchemy.catalogue - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.sqlalchemy.controllers.rst b/doc/source/api/zaqar.storage.sqlalchemy.controllers.rst deleted file mode 100644 index 225060243..000000000 --- a/doc/source/api/zaqar.storage.sqlalchemy.controllers.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.sqlalchemy.controllers` module -======================================================= - -.. automodule:: zaqar.storage.sqlalchemy.controllers - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.sqlalchemy.driver.rst b/doc/source/api/zaqar.storage.sqlalchemy.driver.rst deleted file mode 100644 index b26a3ebf0..000000000 --- a/doc/source/api/zaqar.storage.sqlalchemy.driver.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.sqlalchemy.driver` module -================================================== - -.. automodule:: zaqar.storage.sqlalchemy.driver - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.sqlalchemy.options.rst b/doc/source/api/zaqar.storage.sqlalchemy.options.rst deleted file mode 100644 index 2fc00cf5c..000000000 --- a/doc/source/api/zaqar.storage.sqlalchemy.options.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.sqlalchemy.options` module -=================================================== - -.. automodule:: zaqar.storage.sqlalchemy.options - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.sqlalchemy.pools.rst b/doc/source/api/zaqar.storage.sqlalchemy.pools.rst deleted file mode 100644 index 263c6ef5d..000000000 --- a/doc/source/api/zaqar.storage.sqlalchemy.pools.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.sqlalchemy.pools` module -================================================= - -.. automodule:: zaqar.storage.sqlalchemy.pools - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.sqlalchemy.queues.rst b/doc/source/api/zaqar.storage.sqlalchemy.queues.rst deleted file mode 100644 index 158bac71f..000000000 --- a/doc/source/api/zaqar.storage.sqlalchemy.queues.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.sqlalchemy.queues` module -================================================== - -.. automodule:: zaqar.storage.sqlalchemy.queues - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.sqlalchemy.tables.rst b/doc/source/api/zaqar.storage.sqlalchemy.tables.rst deleted file mode 100644 index 21eb03b18..000000000 --- a/doc/source/api/zaqar.storage.sqlalchemy.tables.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.sqlalchemy.tables` module -================================================== - -.. automodule:: zaqar.storage.sqlalchemy.tables - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.sqlalchemy.utils.rst b/doc/source/api/zaqar.storage.sqlalchemy.utils.rst deleted file mode 100644 index fa5cac1ff..000000000 --- a/doc/source/api/zaqar.storage.sqlalchemy.utils.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.sqlalchemy.utils` module -================================================= - -.. automodule:: zaqar.storage.sqlalchemy.utils - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.storage.utils.rst b/doc/source/api/zaqar.storage.utils.rst deleted file mode 100644 index 99939e740..000000000 --- a/doc/source/api/zaqar.storage.utils.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.storage.utils` module -====================================== - -.. automodule:: zaqar.storage.utils - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.base.rst b/doc/source/api/zaqar.transport.base.rst deleted file mode 100644 index 99da1adbc..000000000 --- a/doc/source/api/zaqar.transport.base.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.base` module -======================================= - -.. automodule:: zaqar.transport.base - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.middleware.auth.rst b/doc/source/api/zaqar.transport.middleware.auth.rst deleted file mode 100644 index d6ee2c7cb..000000000 --- a/doc/source/api/zaqar.transport.middleware.auth.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.middleware.auth` module -================================================= - -.. automodule:: zaqar.transport.middleware.auth - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.utils.rst b/doc/source/api/zaqar.transport.utils.rst deleted file mode 100644 index 34e147e0a..000000000 --- a/doc/source/api/zaqar.transport.utils.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.utils` module -======================================== - -.. automodule:: zaqar.transport.utils - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.validation.rst b/doc/source/api/zaqar.transport.validation.rst deleted file mode 100644 index 1dba434c2..000000000 --- a/doc/source/api/zaqar.transport.validation.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.validation` module -============================================= - -.. automodule:: zaqar.transport.validation - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.websocket.driver.rst b/doc/source/api/zaqar.transport.websocket.driver.rst deleted file mode 100644 index 5c7204a89..000000000 --- a/doc/source/api/zaqar.transport.websocket.driver.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.websocket.driver` module -=================================================== - -.. automodule:: zaqar.transport.websocket.driver - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.websocket.factory.rst b/doc/source/api/zaqar.transport.websocket.factory.rst deleted file mode 100644 index cb850dd8a..000000000 --- a/doc/source/api/zaqar.transport.websocket.factory.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.websocket.factory` module -==================================================== - -.. automodule:: zaqar.transport.websocket.factory - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.websocket.protocol.rst b/doc/source/api/zaqar.transport.websocket.protocol.rst deleted file mode 100644 index 483848601..000000000 --- a/doc/source/api/zaqar.transport.websocket.protocol.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.websocket.protocol` module -===================================================== - -.. automodule:: zaqar.transport.websocket.protocol - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.driver.rst b/doc/source/api/zaqar.transport.wsgi.driver.rst deleted file mode 100644 index 657291023..000000000 --- a/doc/source/api/zaqar.transport.wsgi.driver.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.driver` module -============================================== - -.. automodule:: zaqar.transport.wsgi.driver - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.errors.rst b/doc/source/api/zaqar.transport.wsgi.errors.rst deleted file mode 100644 index d802b0c99..000000000 --- a/doc/source/api/zaqar.transport.wsgi.errors.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.errors` module -============================================== - -.. automodule:: zaqar.transport.wsgi.errors - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.utils.rst b/doc/source/api/zaqar.transport.wsgi.utils.rst deleted file mode 100644 index 20653b870..000000000 --- a/doc/source/api/zaqar.transport.wsgi.utils.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.utils` module -============================================= - -.. automodule:: zaqar.transport.wsgi.utils - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.v1_0.claims.rst b/doc/source/api/zaqar.transport.wsgi.v1_0.claims.rst deleted file mode 100644 index 9b6541670..000000000 --- a/doc/source/api/zaqar.transport.wsgi.v1_0.claims.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.v1_0.claims` module -=================================================== - -.. automodule:: zaqar.transport.wsgi.v1_0.claims - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.v1_0.health.rst b/doc/source/api/zaqar.transport.wsgi.v1_0.health.rst deleted file mode 100644 index 3698986d1..000000000 --- a/doc/source/api/zaqar.transport.wsgi.v1_0.health.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.v1_0.health` module -=================================================== - -.. automodule:: zaqar.transport.wsgi.v1_0.health - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.v1_0.homedoc.rst b/doc/source/api/zaqar.transport.wsgi.v1_0.homedoc.rst deleted file mode 100644 index 57f5d01f6..000000000 --- a/doc/source/api/zaqar.transport.wsgi.v1_0.homedoc.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.v1_0.homedoc` module -==================================================== - -.. automodule:: zaqar.transport.wsgi.v1_0.homedoc - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.v1_0.messages.rst b/doc/source/api/zaqar.transport.wsgi.v1_0.messages.rst deleted file mode 100644 index 2f64fe1e3..000000000 --- a/doc/source/api/zaqar.transport.wsgi.v1_0.messages.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.v1_0.messages` module -===================================================== - -.. automodule:: zaqar.transport.wsgi.v1_0.messages - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.v1_0.metadata.rst b/doc/source/api/zaqar.transport.wsgi.v1_0.metadata.rst deleted file mode 100644 index a31d7b0d2..000000000 --- a/doc/source/api/zaqar.transport.wsgi.v1_0.metadata.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.v1_0.metadata` module -===================================================== - -.. automodule:: zaqar.transport.wsgi.v1_0.metadata - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.v1_0.pools.rst b/doc/source/api/zaqar.transport.wsgi.v1_0.pools.rst deleted file mode 100644 index 299c8c607..000000000 --- a/doc/source/api/zaqar.transport.wsgi.v1_0.pools.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.v1_0.pools` module -================================================== - -.. automodule:: zaqar.transport.wsgi.v1_0.pools - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.v1_0.queues.rst b/doc/source/api/zaqar.transport.wsgi.v1_0.queues.rst deleted file mode 100644 index e1f081d1b..000000000 --- a/doc/source/api/zaqar.transport.wsgi.v1_0.queues.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.v1_0.queues` module -=================================================== - -.. automodule:: zaqar.transport.wsgi.v1_0.queues - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.v1_0.stats.rst b/doc/source/api/zaqar.transport.wsgi.v1_0.stats.rst deleted file mode 100644 index 029b998d4..000000000 --- a/doc/source/api/zaqar.transport.wsgi.v1_0.stats.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.v1_0.stats` module -================================================== - -.. automodule:: zaqar.transport.wsgi.v1_0.stats - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.v1_1.claims.rst b/doc/source/api/zaqar.transport.wsgi.v1_1.claims.rst deleted file mode 100644 index d0faf9c5c..000000000 --- a/doc/source/api/zaqar.transport.wsgi.v1_1.claims.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.v1_1.claims` module -=================================================== - -.. automodule:: zaqar.transport.wsgi.v1_1.claims - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.v1_1.flavors.rst b/doc/source/api/zaqar.transport.wsgi.v1_1.flavors.rst deleted file mode 100644 index a8ad5bfaf..000000000 --- a/doc/source/api/zaqar.transport.wsgi.v1_1.flavors.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.v1_1.flavors` module -==================================================== - -.. automodule:: zaqar.transport.wsgi.v1_1.flavors - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.v1_1.health.rst b/doc/source/api/zaqar.transport.wsgi.v1_1.health.rst deleted file mode 100644 index 6ef908577..000000000 --- a/doc/source/api/zaqar.transport.wsgi.v1_1.health.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.v1_1.health` module -=================================================== - -.. automodule:: zaqar.transport.wsgi.v1_1.health - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.v1_1.homedoc.rst b/doc/source/api/zaqar.transport.wsgi.v1_1.homedoc.rst deleted file mode 100644 index 105e2c472..000000000 --- a/doc/source/api/zaqar.transport.wsgi.v1_1.homedoc.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.v1_1.homedoc` module -==================================================== - -.. automodule:: zaqar.transport.wsgi.v1_1.homedoc - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.v1_1.messages.rst b/doc/source/api/zaqar.transport.wsgi.v1_1.messages.rst deleted file mode 100644 index dfc99d664..000000000 --- a/doc/source/api/zaqar.transport.wsgi.v1_1.messages.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.v1_1.messages` module -===================================================== - -.. automodule:: zaqar.transport.wsgi.v1_1.messages - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.v1_1.ping.rst b/doc/source/api/zaqar.transport.wsgi.v1_1.ping.rst deleted file mode 100644 index 86c4626d2..000000000 --- a/doc/source/api/zaqar.transport.wsgi.v1_1.ping.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.v1_1.ping` module -================================================= - -.. automodule:: zaqar.transport.wsgi.v1_1.ping - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.v1_1.pools.rst b/doc/source/api/zaqar.transport.wsgi.v1_1.pools.rst deleted file mode 100644 index d6e3735d5..000000000 --- a/doc/source/api/zaqar.transport.wsgi.v1_1.pools.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.v1_1.pools` module -================================================== - -.. automodule:: zaqar.transport.wsgi.v1_1.pools - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.v1_1.queues.rst b/doc/source/api/zaqar.transport.wsgi.v1_1.queues.rst deleted file mode 100644 index f6464879b..000000000 --- a/doc/source/api/zaqar.transport.wsgi.v1_1.queues.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.v1_1.queues` module -=================================================== - -.. automodule:: zaqar.transport.wsgi.v1_1.queues - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.v1_1.stats.rst b/doc/source/api/zaqar.transport.wsgi.v1_1.stats.rst deleted file mode 100644 index 9595ec2e1..000000000 --- a/doc/source/api/zaqar.transport.wsgi.v1_1.stats.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.v1_1.stats` module -================================================== - -.. automodule:: zaqar.transport.wsgi.v1_1.stats - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.v2_0.claims.rst b/doc/source/api/zaqar.transport.wsgi.v2_0.claims.rst deleted file mode 100644 index 5e5a4d6b4..000000000 --- a/doc/source/api/zaqar.transport.wsgi.v2_0.claims.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.v2_0.claims` module -=================================================== - -.. automodule:: zaqar.transport.wsgi.v2_0.claims - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.v2_0.flavors.rst b/doc/source/api/zaqar.transport.wsgi.v2_0.flavors.rst deleted file mode 100644 index 4a2f3cb34..000000000 --- a/doc/source/api/zaqar.transport.wsgi.v2_0.flavors.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.v2_0.flavors` module -==================================================== - -.. automodule:: zaqar.transport.wsgi.v2_0.flavors - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.v2_0.health.rst b/doc/source/api/zaqar.transport.wsgi.v2_0.health.rst deleted file mode 100644 index 226dc1e85..000000000 --- a/doc/source/api/zaqar.transport.wsgi.v2_0.health.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.v2_0.health` module -=================================================== - -.. automodule:: zaqar.transport.wsgi.v2_0.health - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.v2_0.homedoc.rst b/doc/source/api/zaqar.transport.wsgi.v2_0.homedoc.rst deleted file mode 100644 index a8fb59bfe..000000000 --- a/doc/source/api/zaqar.transport.wsgi.v2_0.homedoc.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.v2_0.homedoc` module -==================================================== - -.. automodule:: zaqar.transport.wsgi.v2_0.homedoc - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.v2_0.messages.rst b/doc/source/api/zaqar.transport.wsgi.v2_0.messages.rst deleted file mode 100644 index bbe3ea363..000000000 --- a/doc/source/api/zaqar.transport.wsgi.v2_0.messages.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.v2_0.messages` module -===================================================== - -.. automodule:: zaqar.transport.wsgi.v2_0.messages - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.v2_0.ping.rst b/doc/source/api/zaqar.transport.wsgi.v2_0.ping.rst deleted file mode 100644 index 4e63391ec..000000000 --- a/doc/source/api/zaqar.transport.wsgi.v2_0.ping.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.v2_0.ping` module -================================================= - -.. automodule:: zaqar.transport.wsgi.v2_0.ping - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.v2_0.pools.rst b/doc/source/api/zaqar.transport.wsgi.v2_0.pools.rst deleted file mode 100644 index 9744039e2..000000000 --- a/doc/source/api/zaqar.transport.wsgi.v2_0.pools.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.v2_0.pools` module -================================================== - -.. automodule:: zaqar.transport.wsgi.v2_0.pools - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.v2_0.queues.rst b/doc/source/api/zaqar.transport.wsgi.v2_0.queues.rst deleted file mode 100644 index d1020e223..000000000 --- a/doc/source/api/zaqar.transport.wsgi.v2_0.queues.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.v2_0.queues` module -=================================================== - -.. automodule:: zaqar.transport.wsgi.v2_0.queues - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.v2_0.stats.rst b/doc/source/api/zaqar.transport.wsgi.v2_0.stats.rst deleted file mode 100644 index 294dd6a24..000000000 --- a/doc/source/api/zaqar.transport.wsgi.v2_0.stats.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.v2_0.stats` module -================================================== - -.. automodule:: zaqar.transport.wsgi.v2_0.stats - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.v2_0.subscriptions.rst b/doc/source/api/zaqar.transport.wsgi.v2_0.subscriptions.rst deleted file mode 100644 index abb742fd4..000000000 --- a/doc/source/api/zaqar.transport.wsgi.v2_0.subscriptions.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.v2_0.subscriptions` module -========================================================== - -.. automodule:: zaqar.transport.wsgi.v2_0.subscriptions - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.v2_0.urls.rst b/doc/source/api/zaqar.transport.wsgi.v2_0.urls.rst deleted file mode 100644 index b28d40418..000000000 --- a/doc/source/api/zaqar.transport.wsgi.v2_0.urls.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.v2_0.urls` module -================================================= - -.. automodule:: zaqar.transport.wsgi.v2_0.urls - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.transport.wsgi.version.rst b/doc/source/api/zaqar.transport.wsgi.version.rst deleted file mode 100644 index b49732aa8..000000000 --- a/doc/source/api/zaqar.transport.wsgi.version.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.transport.wsgi.version` module -=============================================== - -.. automodule:: zaqar.transport.wsgi.version - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/zaqar.version.rst b/doc/source/api/zaqar.version.rst deleted file mode 100644 index d468d297f..000000000 --- a/doc/source/api/zaqar.version.rst +++ /dev/null @@ -1,7 +0,0 @@ -The :mod:`zaqar.version` module -================================ - -.. automodule:: zaqar.version - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/devref/development.environment.rst b/doc/source/contributor/development.environment.rst similarity index 97% rename from doc/source/devref/development.environment.rst rename to doc/source/contributor/development.environment.rst index 19c665fe9..52e6d9898 100644 --- a/doc/source/devref/development.environment.rst +++ b/doc/source/contributor/development.environment.rst @@ -49,7 +49,7 @@ Install GNU/Linux system dependencies This section is tested for Zaqar on Ubuntu 14.04 (Trusty) and Fedora-based (RHEL 6.1) distributions. Feel free to add notes and change according to your experiences or operating system. Learn more about contributing to Zaqar - documentation in the :doc:`../welcome` manual. + documentation in the :doc:`welcome` manual. Install the prerequisite packages. @@ -285,14 +285,14 @@ Then run the ``stack.sh`` script as usual. Running tests ------------- -See :doc:`../running_tests` for details. +See :doc:`running_tests` for details. Running the benchmarking tool ----------------------------- -See :doc:`../running_benchmark` for details. +See :doc:`../admin/running_benchmark` for details. Contributing your work ---------------------- -See :doc:`../welcome` and :doc:`../first_patch` for details. +See :doc:`welcome` and :doc:`first_patch` for details. diff --git a/doc/source/first_patch.rst b/doc/source/contributor/first_patch.rst similarity index 99% rename from doc/source/first_patch.rst rename to doc/source/contributor/first_patch.rst index 1140920cd..f08aef48c 100644 --- a/doc/source/first_patch.rst +++ b/doc/source/contributor/first_patch.rst @@ -106,7 +106,7 @@ Clone the Zaqar repository with the following git command: $ git clone git://git.openstack.org/openstack/zaqar.git For information on how to set up the Zaqar development environment -see :doc:`devref/development.environment`. +see :doc:`development.environment`. Before writing code, you will have to do some configurations to connect your local repository with Gerrit. You will only need to do this your first time diff --git a/doc/source/first_review.rst b/doc/source/contributor/first_review.rst similarity index 100% rename from doc/source/first_review.rst rename to doc/source/contributor/first_review.rst diff --git a/doc/source/gerrit.rst b/doc/source/contributor/gerrit.rst similarity index 100% rename from doc/source/gerrit.rst rename to doc/source/contributor/gerrit.rst diff --git a/doc/source/images/zaqar_review_id.png b/doc/source/contributor/images/zaqar_review_id.png similarity index 100% rename from doc/source/images/zaqar_review_id.png rename to doc/source/contributor/images/zaqar_review_id.png diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 000000000..d06ec1898 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,42 @@ +================== +Contribution Guide +================== + +.. toctree:: + :maxdepth: 2 + + welcome + development.environment + first_patch + first_review + launchpad + gerrit + jenkins + reviewer_guide + running_tests + test_suite + +Modules reference +~~~~~~~~~~~~~~~~~ + +Zaqar is composed of two layers: + +.. toctree:: + :maxdepth: 1 + + transport + storage + +The **transport drivers** are responsible for interacting with Zaqar clients. +Every query made by clients is processed by the transport layer, which is in +charge of passing this information to the backend and then returning the +response in a format understandable by the client. + +The **storage drivers** are responsible for interacting with the storage +backends and, that way, store or retrieve the data coming from the transport +layer. + +In order to keep these layers decoupled, we have established that +**checks should be performed in the appropriate layer**. In other words, +transport drivers must guarantee that the incoming data is well-formed and +storage drivers must enforce their data model stays consistent. \ No newline at end of file diff --git a/doc/source/jenkins.rst b/doc/source/contributor/jenkins.rst similarity index 100% rename from doc/source/jenkins.rst rename to doc/source/contributor/jenkins.rst diff --git a/doc/source/launchpad.rst b/doc/source/contributor/launchpad.rst similarity index 100% rename from doc/source/launchpad.rst rename to doc/source/contributor/launchpad.rst diff --git a/doc/source/reviewer_guide.rst b/doc/source/contributor/reviewer_guide.rst similarity index 100% rename from doc/source/reviewer_guide.rst rename to doc/source/contributor/reviewer_guide.rst diff --git a/doc/source/running_tests.rst b/doc/source/contributor/running_tests.rst similarity index 100% rename from doc/source/running_tests.rst rename to doc/source/contributor/running_tests.rst diff --git a/doc/source/storage/api.rst b/doc/source/contributor/storage.rst similarity index 82% rename from doc/source/storage/api.rst rename to doc/source/contributor/storage.rst index f60df5405..f5f592b80 100644 --- a/doc/source/storage/api.rst +++ b/doc/source/contributor/storage.rst @@ -23,3 +23,10 @@ API reference for storage drivers .. autoclass:: Claim :noindex: :members: + + +-------------- +MongoDB Driver +-------------- + +.. automodule:: zaqar.storage.mongodb diff --git a/doc/source/test_suite.rst b/doc/source/contributor/test_suite.rst similarity index 100% rename from doc/source/test_suite.rst rename to doc/source/contributor/test_suite.rst diff --git a/doc/source/transport.rst b/doc/source/contributor/transport.rst similarity index 100% rename from doc/source/transport.rst rename to doc/source/contributor/transport.rst diff --git a/doc/source/welcome.rst b/doc/source/contributor/welcome.rst similarity index 100% rename from doc/source/welcome.rst rename to doc/source/contributor/welcome.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 09053ec5f..b39dc1901 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -11,9 +11,9 @@ License for the specific language governing permissions and limitations under the License. -============================================= -Welcome to the Zaqar Developer Documentation! -============================================= +===================================== +Welcome to the Zaqar's Documentation! +===================================== Zaqar is a multi-tenant cloud messaging and notification service for web and mobile developers. @@ -27,17 +27,8 @@ API is also available. Other OpenStack components can integrate with Zaqar to surface events to end users and to communicate with guest agents that run in the "over-cloud" layer. -.. note:: This documentation is generated by the Sphinx toolkit and lives in - the Zaqar project source tree. Additional draft and project documentation - regarding Zaqar and other components of OpenStack can be found on the - `OpenStack Wiki`_, as well as in the user guides found on - `docs.openstack.org`_. - -.. _`OpenStack Wiki`: http://wiki.openstack.org -.. _`docs.openstack.org`: http://docs.openstack.org - Key features -============ +------------ Zaqar provides the following key features: @@ -71,7 +62,7 @@ Zaqar provides the following key features: * Websocket notifications. Project scope -============= +------------- The Zaqar API is data-oriented. That is, it does not provision message brokers and expose those directly to clients. Instead, the API acts as a bridge between @@ -82,7 +73,7 @@ provisioning service, the community should consider starting a new project to address that need. Design principles -================= +----------------- Zaqar, as with all OpenStack projects, is designed with the following guidelines in mind: @@ -93,133 +84,25 @@ guidelines in mind: * **Recoverable.** Failures should be easy to diagnose, debug, and rectify * **Open standards.** Be a reference implementation for a community-driven -Concepts -======== +Contents +-------- +.. toctree:: + :maxdepth: 2 + + user/index + admin/index + install/index + contributor/index .. toctree:: :maxdepth: 1 glossary -Modules reference -================= -Zaqar is composed of two layers: -.. toctree:: - :maxdepth: 1 - transport - storage/autoindex -The **transport drivers** are responsible for interacting with Zaqar clients. -Every query made by clients is processed by the transport layer, which is in -charge of passing this information to the backend and then returning the -response in a format understandable by the client. -The **storage drivers** are responsible for interacting with the storage -backends and, that way, store or retrieve the data coming from the transport -layer. -In order to keep these layers decoupled, we have established that -**checks should be performed in the appropriate layer**. In other words, -transport drivers must guarantee that the incoming data is well-formed and -storage drivers must enforce their data model stays consistent. -User Guide -========== - -.. toctree:: - :maxdepth: 1 - - getting_started - send_request_api.rst - authentication_tokens.rst - headers_queue_api_working.rst - -Setting up Zaqar in development environment -=========================================== - -.. toctree:: - :maxdepth: 1 - - devref/development.environment - -Welcome new contributors -======================== - -.. toctree:: - :maxdepth: 1 - - welcome - first_patch - first_review - -Running and writing tests -========================= - -.. toctree:: - :maxdepth: 1 - - running_tests - test_suite - -Reviewing -========= - -.. toctree:: - :maxdepth: 1 - - reviewer_guide - -Tutorials -========= - -.. toctree:: - :maxdepth: 1 - - running_benchmark - writing_pipeline_stages - -Feature Guide -============= - -.. toctree:: - :maxdepth: 1 - - subscription_confirm - OSprofiler - CORS - -Other resources -=============== - -.. toctree:: - :maxdepth: 3 - - launchpad - gerrit - jenkins - -Internal API reference -====================== - -.. toctree:: - :maxdepth: 3 - - api/autoindex - -Guru Meditation Reports -======================= - -.. toctree:: - :maxdepth: 1 - - devref/gmr - -Indices and tables ------------------- - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/install-guide/source/get_started.rst b/doc/source/install/get_started.rst similarity index 100% rename from install-guide/source/get_started.rst rename to doc/source/install/get_started.rst diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst new file mode 100644 index 000000000..89b85bbfe --- /dev/null +++ b/doc/source/install/index.rst @@ -0,0 +1,41 @@ +================== +Installation Guide +================== + +.. toctree:: + + get_started.rst + install.rst + verify.rst + next-steps.rst + +The Messaging service is multi-tenant, fast, reliable, and scalable. It allows +developers to share data between distributed application components performing +different tasks, without losing messages or requiring each component to be +always available. + +The service features a RESTful API and a Websocket API, which developers can +use to send messages between various components of their SaaS and mobile +applications, by using a variety of communication patterns. + +This chapter assumes a working setup of OpenStack following the base +Installation Guide. + + +Ocata +~~~~~ + +To install Glance, see the Ocata Image service install guide for each distribution: + +- `Ubuntu `__ +- `CentOS and RHEL `__ +- `openSUSE and SUSE Linux Enterprise `__ + +Newton +~~~~~~ + +To install Glance, see the Newton Image service install guide for each distribution: + +- `Ubuntu `__ +- `CentOS and RHEL `__ +- `openSUSE and SUSE Linux Enterprise `__ diff --git a/install-guide/source/install-obs.rst b/doc/source/install/install-obs.rst similarity index 100% rename from install-guide/source/install-obs.rst rename to doc/source/install/install-obs.rst diff --git a/install-guide/source/install-rdo.rst b/doc/source/install/install-rdo.rst similarity index 100% rename from install-guide/source/install-rdo.rst rename to doc/source/install/install-rdo.rst diff --git a/install-guide/source/install-ubuntu.rst b/doc/source/install/install-ubuntu.rst similarity index 100% rename from install-guide/source/install-ubuntu.rst rename to doc/source/install/install-ubuntu.rst diff --git a/install-guide/source/install.rst b/doc/source/install/install.rst similarity index 100% rename from install-guide/source/install.rst rename to doc/source/install/install.rst diff --git a/install-guide/source/next-steps.rst b/doc/source/install/next-steps.rst similarity index 100% rename from install-guide/source/next-steps.rst rename to doc/source/install/next-steps.rst diff --git a/install-guide/source/verify.rst b/doc/source/install/verify.rst similarity index 100% rename from install-guide/source/verify.rst rename to doc/source/install/verify.rst diff --git a/doc/source/storage/autoindex.rst b/doc/source/storage/autoindex.rst deleted file mode 100644 index 0fefd2566..000000000 --- a/doc/source/storage/autoindex.rst +++ /dev/null @@ -1,12 +0,0 @@ -------------- -Storage Layer -------------- - -The **storage drivers** are responsible for interacting with the storage backends -and, that way, store or retrieve the data coming from the transport layer. - -.. toctree:: - :maxdepth: 1 - - api - mongodb diff --git a/doc/source/storage/mongodb.rst b/doc/source/storage/mongodb.rst deleted file mode 100644 index 983a52109..000000000 --- a/doc/source/storage/mongodb.rst +++ /dev/null @@ -1,5 +0,0 @@ --------------- -MongoDB Driver --------------- - -.. automodule:: zaqar.storage.mongodb diff --git a/doc/source/authentication_tokens.rst b/doc/source/user/authentication_tokens.rst similarity index 100% rename from doc/source/authentication_tokens.rst rename to doc/source/user/authentication_tokens.rst diff --git a/doc/source/getting_started.rst b/doc/source/user/getting_started.rst similarity index 100% rename from doc/source/getting_started.rst rename to doc/source/user/getting_started.rst diff --git a/doc/source/headers_queue_api_working.rst b/doc/source/user/headers_queue_api_working.rst similarity index 100% rename from doc/source/headers_queue_api_working.rst rename to doc/source/user/headers_queue_api_working.rst diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst new file mode 100644 index 000000000..546f68ae1 --- /dev/null +++ b/doc/source/user/index.rst @@ -0,0 +1,11 @@ +========== +User Guide +========== + +.. toctree:: + :maxdepth: 2 + + getting_started + send_request_api + authentication_tokens + headers_queue_api_working diff --git a/doc/source/send_request_api.rst b/doc/source/user/send_request_api.rst similarity index 100% rename from doc/source/send_request_api.rst rename to doc/source/user/send_request_api.rst diff --git a/install-guide/source/conf.py b/install-guide/source/conf.py deleted file mode 100644 index 1d79a51d5..000000000 --- a/install-guide/source/conf.py +++ /dev/null @@ -1,301 +0,0 @@ -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or -# implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import os -# import sys - - -import openstackdocstheme - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -# needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -# TODO(ajaeger): enable PDF building, for example add 'rst2pdf.pdfbuilder' -# extensions = - -# Add any paths that contain templates here, relative to this directory. -# templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -# source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'Installation Guide for Messaging Service' -bug_tag = u'install-guide' -copyright = u'2016, OpenStack contributors' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = '0.1' -# The full version, including alpha/beta/rc tags. -release = '0.1' - -# A few variables have to be set for the log-a-bug feature. -# giturl: The location of conf.py on Git. Must be set manually. -# gitsha: The SHA checksum of the bug description. Automatically extracted -# from git log. -# bug_tag: Tag for categorizing the bug. Must be set manually. -# These variables are passed to the logabug code via html_context. -giturl = (u'http://git.openstack.org/cgit/openstack/zaqar/tree/install-guide' - u'/source') -git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '" -gitsha = os.popen(git_cmd).read().strip('\n') -html_context = {"gitsha": gitsha, "bug_tag": bug_tag, - "giturl": giturl} - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = [] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = 'openstackdocs' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -html_theme_path = [openstackdocstheme.get_html_theme_path()] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -# html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -# html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -# html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -# html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -# html_static_path = [] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -# html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# So that we can enable "log-a-bug" links from each output HTML page, this -# variable must be set to a format that includes year, month, day, hours and -# minutes. -html_last_updated_fmt = '%Y-%m-%d %H:%M' - - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# html_additional_pages = {} - -# If false, no module index is generated. -# html_domain_indices = True - -# If false, no index is generated. -html_use_index = False - -# If true, the index is split into individual pages for each letter. -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -html_show_sourcelink = False - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None - -# Output file base name for HTML help builder. -htmlhelp_basename = 'install-guide' - -# If true, publish source files -html_copy_source = False - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # 'preamble': '', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - ('index', 'InstallGuide.tex', u'Install Guide', - u'OpenStack contributors', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# If true, show page references after internal links. -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# latex_show_urls = False - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'installguide', u'Install Guide', - [u'OpenStack contributors'], 1) -] - -# If true, show URL addresses after external links. -# man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ('index', 'InstallGuide', u'Install Guide', - u'OpenStack contributors', 'InstallGuide', - 'This guide shows OpenStack end users how to install ' - 'an OpenStack cloud.', 'Miscellaneous'), -] - -# Documents to append as an appendix to all manuals. -# texinfo_appendices = [] - -# If false, no module index is generated. -# texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# texinfo_no_detailmenu = False - -# -- Options for Internationalization output ------------------------------ -locale_dirs = ['locale/'] - -# -- Options for PDF output -------------------------------------------------- - -pdf_documents = [ - ('index', u'InstallGuide', u'Install Guide', - u'OpenStack contributors') -] diff --git a/install-guide/source/index.rst b/install-guide/source/index.rst deleted file mode 100644 index a00da0061..000000000 --- a/install-guide/source/index.rst +++ /dev/null @@ -1,22 +0,0 @@ -================= -Messaging service -================= - -.. toctree:: - - get_started.rst - install.rst - verify.rst - next-steps.rst - -The Messaging service is multi-tenant, fast, reliable, and scalable. It allows -developers to share data between distributed application components performing -different tasks, without losing messages or requiring each component to be -always available. - -The service features a RESTful API and a Websocket API, which developers can -use to send messages between various components of their SaaS and mobile -applications, by using a variety of communication patterns. - -This chapter assumes a working setup of OpenStack following the base -Installation Guide.