Fix doc warnings
When building the docs using `tox -e docs`, several warning messages would print out. This change fixes the issues causing those warnings. Change-Id: I57503c75f6c07c020bb3bfa34de6aa8f66983ff7
This commit is contained in:
parent
11bcb88a2f
commit
3169ac4e18
@ -1,6 +1,6 @@
|
|||||||
===================
|
===============================================
|
||||||
Cloud Administrator Guide - Key Manager service
|
Cloud Administrator Guide - Key Manager service
|
||||||
===================
|
===============================================
|
||||||
|
|
||||||
The Key Manager service, code-named Barbican, is the default secret storage
|
The Key Manager service, code-named Barbican, is the default secret storage
|
||||||
service for OpenStack. The service provides secure storage, provisioning and
|
service for OpenStack. The service provides secure storage, provisioning and
|
||||||
|
@ -98,22 +98,22 @@ Request:
|
|||||||
Response Attributes
|
Response Attributes
|
||||||
*******************
|
*******************
|
||||||
|
|
||||||
+----------+---------+---------------------------------------------------------------+
|
+-----------+---------+----------------------------------------------------------------+
|
||||||
| Name | Type | Description |
|
| Name | Type | Description |
|
||||||
+==========+=========+============================================================== +
|
+===========+=========+================================================================+
|
||||||
| consumers| list | Contains a list of dictionaries filled with consumer metadata.|
|
| consumers | list | Contains a list of dictionaries filled with consumer metadata. |
|
||||||
+----------+---------+---------------------------------------------------------------+
|
+-----------+---------+----------------------------------------------------------------+
|
||||||
| total | integer | The total number of consumers available to the user. |
|
| total | integer | The total number of consumers available to the user. |
|
||||||
+----------+---------+---------------------------------------------------------------+
|
+-----------+---------+----------------------------------------------------------------+
|
||||||
| next | string | A HATEOAS url to retrieve the next set of consumers based on |
|
| next | string | A HATEOAS url to retrieve the next set of consumers based on |
|
||||||
| | | the offset and limit parameters. This attribute is only |
|
| | | the offset and limit parameters. This attribute is only |
|
||||||
| | | available when the total number of consumers is greater than |
|
| | | available when the total number of consumers is greater than |
|
||||||
| | | offset and limit parameter combined. |
|
| | | offset and limit parameter combined. |
|
||||||
+----------+---------+---------------------------------------------------------------+
|
+-----------+---------+----------------------------------------------------------------+
|
||||||
| previous | string | A HATEOAS url to retrieve the previous set of consumers based |
|
| previous | string | A HATEOAS url to retrieve the previous set of consumers based |
|
||||||
| | | on the offset and limit parameters. This attribute is only |
|
| | | on the offset and limit parameters. This attribute is only |
|
||||||
| | | available when the request offset is greater than 0. |
|
| | | available when the request offset is greater than 0. |
|
||||||
+----------+---------+---------------------------------------------------------------+
|
+-----------+---------+----------------------------------------------------------------+
|
||||||
|
|
||||||
|
|
||||||
.. _consumer_status_codes:
|
.. _consumer_status_codes:
|
||||||
|
@ -56,7 +56,7 @@ Request:
|
|||||||
|
|
||||||
|
|
||||||
Response:
|
Response:
|
||||||
********
|
*********
|
||||||
|
|
||||||
.. code-block:: javascript
|
.. code-block:: javascript
|
||||||
|
|
||||||
|
@ -88,7 +88,7 @@ Response:
|
|||||||
}
|
}
|
||||||
],
|
],
|
||||||
"total": 2
|
"total": 2
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
.. _get_order_response_attributes:
|
.. _get_order_response_attributes:
|
||||||
|
@ -52,7 +52,7 @@ For **asynchronous** calls, the following sequence is generally followed:
|
|||||||
``on_post()`` is invoked.
|
``on_post()`` is invoked.
|
||||||
#. The ``OrderRepo`` repository class (found in
|
#. The ``OrderRepo`` repository class (found in
|
||||||
``barbican/model/respositories.py``) is then used to create the
|
``barbican/model/respositories.py``) is then used to create the
|
||||||
``barbican/model/models.py``'s ``Order``entity in a 'PENDING' state.
|
``barbican/model/models.py``'s ``Order`` entity in a 'PENDING' state.
|
||||||
#. The Queue API's ``process_type_order()`` method on the ``TaskClient``
|
#. The Queue API's ``process_type_order()`` method on the ``TaskClient``
|
||||||
class (found in ``barbican/queue/client.py``) is invoked to send a
|
class (found in ``barbican/queue/client.py``) is invoked to send a
|
||||||
message to the queue for asynchronous processing.
|
message to the queue for asynchronous processing.
|
||||||
|
@ -24,5 +24,5 @@ instead. In case of API, replace ``'X-Auth-Token: $TOKEN'`` with
|
|||||||
|
|
||||||
You can also find detailed explanation to run barbican client with an
|
You can also find detailed explanation to run barbican client with an
|
||||||
unauthenticated context
|
unauthenticated context
|
||||||
`here <http://docs.openstack.org/developer/python-barbicanclient/authentication.html#unauthenticated-context>`_ and run barbican CLI in no auth mode
|
`here <http://docs.openstack.org/developer/python-barbicanclient/authentication.html#unauthenticated-context>`__ and run barbican CLI in no auth mode
|
||||||
`here <http://docs.openstack.org/developer/python-barbicanclient/authentication.html#no-auth-mode>`_.
|
`here <http://docs.openstack.org/developer/python-barbicanclient/authentication.html#no-auth-mode>`__.
|
||||||
|
@ -126,7 +126,7 @@ tests should run.
|
|||||||
|
|
||||||
|
|
||||||
Barbican's tox tests fail with "ImportError: No module named _bsddb"
|
Barbican's tox tests fail with "ImportError: No module named _bsddb"
|
||||||
-------------------------------------------------
|
--------------------------------------------------------------------
|
||||||
|
|
||||||
What you might see
|
What you might see
|
||||||
^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^
|
||||||
|
Loading…
Reference in New Issue
Block a user