Refactor the doc tree

This patch refactor zaqar doc according to
the doc-migration spec.

api, cli, configuration and reference should
be added in the next few patches if need.

Change-Id: I74a4949f4eace423c06ab6e8d95838df1f312d93
This commit is contained in:
wangxiyuan 2017-07-04 16:49:44 +08:00
parent c5dcfba0dd
commit 13b85cc38f
148 changed files with 143 additions and 1237 deletions

View File

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

View File

@ -0,0 +1,13 @@
====================
Administration Guide
====================
.. toctree::
:maxdepth: 2
subscription_confirm
OSprofiler
CORS
gmr
running_benchmark
writing_pipeline_stages

View File

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

View File

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

View File

@ -1,5 +0,0 @@
.. toctree::
:glob:
:maxdepth: 1
*

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

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