openstack/barbican
Code Issues Proposed changes

Fix doc warnings

Browse Source 
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:
Kaitlin Farr 2016-05-19 15:22:20 -04:00
parent 11bcb88a2f
commit 3169ac4e18
7 changed files with 27 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/admin-guide-cloud/index.rst
View File

@ -1,6 +1,6 @@
===================
===============================================
Cloud Administrator Guide - Key Manager service
===================
===============================================
The Key Manager service, code-named Barbican, is the default secret storage
service for OpenStack. The service provides secure storage, provisioning and

32
doc/source/api/reference/consumers.rst
View File

@ -98,22 +98,22 @@ Request:
Response Attributes
*******************
+----------+---------+---------------------------------------------------------------+
| Name | Type | Description |
+==========+=========+============================================================== +
| consumers| list | Contains a list of dictionaries filled with consumer metadata.|
+----------+---------+---------------------------------------------------------------+
| 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 |
| | | the offset and limit parameters. This attribute is only |
| | | available when the total number of consumers is greater than |
| | | offset and limit parameter combined. |
+----------+---------+---------------------------------------------------------------+
| previous | string | A HATEOAS url to retrieve the previous set of consumers based |
| | | on the offset and limit parameters. This attribute is only |
| | | available when the request offset is greater than 0. |
+----------+---------+---------------------------------------------------------------+
+-----------+---------+----------------------------------------------------------------+
| Name | Type | Description |
+===========+=========+================================================================+
| consumers | list | Contains a list of dictionaries filled with consumer metadata. |
+-----------+---------+----------------------------------------------------------------+
| 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 |
| | | the offset and limit parameters. This attribute is only |
| | | available when the total number of consumers is greater than |
| | | offset and limit parameter combined. |
+-----------+---------+----------------------------------------------------------------+
| previous | string | A HATEOAS url to retrieve the previous set of consumers based |
| | | on the offset and limit parameters. This attribute is only |
| | | available when the request offset is greater than 0. |
+-----------+---------+----------------------------------------------------------------+
.. _consumer_status_codes:

2
doc/source/api/reference/containers.rst
View File

@ -56,7 +56,7 @@ Request:
Response:
********
*********
.. code-block:: javascript

8
doc/source/api/reference/orders.rst
View File

@ -86,9 +86,9 @@ Response:
"type": "key",
"updated": "2015-10-20T18:38:47"
}
],
"total": 2
}
],
"total": 2
}
.. _get_order_response_attributes:
@ -361,4 +361,4 @@ HTTP Status Codes
| 401 | Invalid X-Auth-Token or the token doesn't have permissions to this resource |
+------+-----------------------------------------------------------------------------+
| 404 | Not Found |
+------+-----------------------------------------------------------------------------+
+------+-----------------------------------------------------------------------------+

2
doc/source/contribute/dataflow.rst
View File

@ -52,7 +52,7 @@ For **asynchronous** calls, the following sequence is generally followed:
``on_post()`` is invoked.
#. The ``OrderRepo`` repository class (found in
``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``
class (found in ``barbican/queue/client.py``) is invoked to send a
message to the queue for asynchronous processing.

4
doc/source/setup/noauth.rst
View File

@ -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
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#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>`__.

2
doc/source/setup/troubleshooting.rst
View File

@ -126,7 +126,7 @@ tests should run.
Barbican's tox tests fail with "ImportError: No module named _bsddb"
-------------------------------------------------
--------------------------------------------------------------------
What you might see
^^^^^^^^^^^^^^^^^^