Follow the new PTI for document build
For compliance with the Project Testing Interface as described in: https://governance.openstack.org/tc/reference/project-testing-interface.html http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html Remove [build_sphinx] section as described in: http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html Change-Id: Ief4342133f5b2f094feb9816f154c6d17a2d028e
This commit is contained in:
Nguyen Hai
parent
08869e539e
commit
a38a7ecb63
@ -2,8 +2,8 @@
|
||||
Team and repository tags
|
||||
========================
|
||||
|
||||
.. image:: http://governance.openstack.org/badges/python-zaqarclient.svg
|
||||
:target: http://governance.openstack.org/reference/tags/index.html
|
||||
.. image:: http://governance.openstack.org/tc/badges/python-zaqarclient.svg
|
||||
:target: http://governance.openstack.org/tc/reference/tags/index.html
|
||||
|
||||
.. Change things from this point on
|
||||
|
||||
|
||||
8
doc/requirements.txt
Normal file
8
doc/requirements.txt
Normal file
@ -0,0 +1,8 @@
|
||||
# The order of packages is significant, because pip processes them in the order
|
||||
# of appearance. Changing the order has an impact on the overall integration
|
||||
# process, which may cause wedges in the gate later.
|
||||
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
|
||||
os-client-config>=1.28.0 # Apache-2.0
|
||||
openstackdocstheme>=1.18.1 # Apache-2.0
|
||||
reno>=2.5.0 # Apache-2.0
|
||||
requests-mock>=1.2.0 # Apache-2.0
|
||||
@ -55,7 +55,7 @@ Create claim and return a list of claimed messages.
|
||||
.. _openstack_messaging_claim_create:
|
||||
|
||||
openstack messaging claim create
|
||||
----------------------
|
||||
--------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@ -109,7 +109,7 @@ Display claim details.
|
||||
.. _openstack_messaging_claim_query:
|
||||
|
||||
openstack messaging claim query
|
||||
---------------------
|
||||
-------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@ -151,7 +151,7 @@ Delete a claim.
|
||||
.. _openstack_messaging_claim_release:
|
||||
|
||||
openstack messaging claim release
|
||||
-----------------------
|
||||
---------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@ -184,7 +184,7 @@ Renew a claim.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<queue_name> ``
|
||||
``<queue_name>``
|
||||
Name of the claimed queue.
|
||||
|
||||
``<claim_id>``
|
||||
@ -201,7 +201,7 @@ Renew a claim.
|
||||
.. _openstack_messaging_claim_renew:
|
||||
|
||||
openstack messaging claim renew
|
||||
---------------------
|
||||
-------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@ -215,7 +215,7 @@ Renew a claim.
|
||||
|
||||
**Positional arguments:**
|
||||
|
||||
``<queue_name> ``
|
||||
``<queue_name>``
|
||||
Name of the claimed queue.
|
||||
|
||||
``<claim_id>``
|
||||
|
||||
@ -60,7 +60,7 @@ Create a pool.
|
||||
.. _openstack_messaging_pool_create:
|
||||
|
||||
openstack messaging pool create
|
||||
---------------------
|
||||
-------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@ -111,7 +111,7 @@ Delete a pool.
|
||||
.. _openstack_messaging_pool_delete:
|
||||
|
||||
openstack messaging pool delete
|
||||
---------------------
|
||||
-------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@ -153,7 +153,7 @@ List available Pools.
|
||||
.. _openstack_messaging_pool_list:
|
||||
|
||||
openstack messaging pool list
|
||||
-------------------
|
||||
-----------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@ -198,7 +198,7 @@ Display pool details.
|
||||
.. _openstack_messaging_pool_show:
|
||||
|
||||
openstack messaging pool show
|
||||
-------------------
|
||||
-----------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@ -254,7 +254,7 @@ Update a pool attribute.
|
||||
.. _openstack_messaging_pool_update:
|
||||
|
||||
openstack messaging pool update
|
||||
---------------------
|
||||
-------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
|
||||
@ -48,7 +48,7 @@ Create a queue.
|
||||
.. _openstack_messaging_queue_create:
|
||||
|
||||
openstack messaging queue create
|
||||
----------------------
|
||||
--------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@ -83,7 +83,7 @@ Delete a queue.
|
||||
.. _openstack_messaging_queue_delete:
|
||||
|
||||
openstack messaging queue delete
|
||||
----------------------
|
||||
--------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@ -118,7 +118,7 @@ Get queue metadata.
|
||||
.. _openstack_messaging_queue_get_metadata:
|
||||
|
||||
openstack messaging queue get metadata
|
||||
----------------------------
|
||||
--------------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@ -163,7 +163,7 @@ List available queues.
|
||||
.. _openstack_messaging_queue_list:
|
||||
|
||||
openstack messaging queue list
|
||||
--------------------
|
||||
------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@ -208,7 +208,7 @@ Set queue metadata.
|
||||
.. _openstack_messaging_queue_set_metadata:
|
||||
|
||||
openstack messaging queue set metadata
|
||||
----------------------------
|
||||
--------------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@ -264,7 +264,7 @@ Create a pre-signed url for the queue.
|
||||
.. _openstack_messaging_queue_signed_url:
|
||||
|
||||
openstack messaging queue signed url
|
||||
--------------------------
|
||||
------------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@ -319,7 +319,7 @@ Get queue stats.
|
||||
.. _openstack_messaging_queue_stats:
|
||||
|
||||
openstack messaging queue stats
|
||||
---------------------
|
||||
-------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@ -357,13 +357,13 @@ the queue will be purged by default.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``--resource_types <resource_types>`
|
||||
``--resource_types <resource_types>``
|
||||
Resource types want to be purged. Support ``messages`` and ``subscriptions``.
|
||||
|
||||
.. _openstack_messaging_queue_purge:
|
||||
|
||||
openstack messaging queue purge
|
||||
---------------------
|
||||
-------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@ -382,5 +382,5 @@ the queue will be purged by default.
|
||||
|
||||
**Optional arguments:**
|
||||
|
||||
``--resource_types <resource_types>`
|
||||
``--resource_types <resource_types>``
|
||||
Resource types want to be purged. Support ``messages`` and ``subscriptions``.
|
||||
|
||||
@ -51,7 +51,7 @@ Create a subscription.
|
||||
.. _openstack_messaging_subscription_create:
|
||||
|
||||
openstack messaging subscription create
|
||||
-----------------------------
|
||||
---------------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@ -96,7 +96,7 @@ Delete a subscription.
|
||||
.. _openstack_messaging_subscription_delete:
|
||||
|
||||
openstack messaging subscription delete
|
||||
-----------------------------
|
||||
---------------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@ -137,7 +137,7 @@ Get list of subscriptions.
|
||||
.. _openstack_messaging_subscription_list:
|
||||
|
||||
openstack messaging subscription list
|
||||
---------------------------
|
||||
-------------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@ -181,7 +181,7 @@ Query a subscription details.
|
||||
.. _openstack_messaging_subscription_show:
|
||||
|
||||
openstack messaging subscription show
|
||||
---------------------------
|
||||
-------------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@ -238,7 +238,7 @@ Update a subscription.
|
||||
.. _openstack_messaging_subscription_update:
|
||||
|
||||
openstack messaging subscription update
|
||||
-----------------------------
|
||||
---------------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
|
||||
@ -144,13 +144,5 @@ openstack.cli.extension =
|
||||
where=tests
|
||||
verbosity=2
|
||||
|
||||
[build_sphinx]
|
||||
source-dir = doc/source
|
||||
build-dir = doc/build
|
||||
all_files = 1
|
||||
|
||||
[upload_sphinx]
|
||||
upload-dir = doc/build/html
|
||||
|
||||
[wheel]
|
||||
universal = 1
|
||||
|
||||
@ -19,10 +19,4 @@ openstack.nose-plugin>=0.7 # Apache-2.0
|
||||
coverage!=4.4,>=4.0 # Apache-2.0
|
||||
|
||||
ddt>=1.0.1 # MIT
|
||||
|
||||
# Documentation
|
||||
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
|
||||
os-client-config>=1.28.0 # Apache-2.0
|
||||
openstackdocstheme>=1.18.1 # Apache-2.0
|
||||
reno>=2.5.0 # Apache-2.0
|
||||
requests-mock>=1.2.0 # Apache-2.0
|
||||
|
||||
4
tox.ini
4
tox.ini
@ -37,9 +37,11 @@ setenv = {[testenv]setenv}
|
||||
commands = {posargs}
|
||||
|
||||
[testenv:docs]
|
||||
commands = python setup.py build_sphinx
|
||||
deps = -r{toxinidir}/doc/requirements.txt
|
||||
commands = sphinx-build -b html doc/source doc/build/html
|
||||
|
||||
[testenv:releasenotes]
|
||||
deps = -r{toxinidir}/doc/requirements.txt
|
||||
commands = sphinx-build -a -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
|
||||
|
||||
[flake8]
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user