From 3169ac4e18f220b90a254c0d7cdca5b26d72881a Mon Sep 17 00:00:00 2001 From: Kaitlin Farr Date: Thu, 19 May 2016 15:22:20 -0400 Subject: [PATCH] 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 --- doc/source/admin-guide-cloud/index.rst | 4 ++-- doc/source/api/reference/consumers.rst | 32 ++++++++++++------------- doc/source/api/reference/containers.rst | 2 +- doc/source/api/reference/orders.rst | 8 +++---- doc/source/contribute/dataflow.rst | 2 +- doc/source/setup/noauth.rst | 4 ++-- doc/source/setup/troubleshooting.rst | 2 +- 7 files changed, 27 insertions(+), 27 deletions(-) diff --git a/doc/source/admin-guide-cloud/index.rst b/doc/source/admin-guide-cloud/index.rst index 0242ceaaa..229a9b476 100644 --- a/doc/source/admin-guide-cloud/index.rst +++ b/doc/source/admin-guide-cloud/index.rst @@ -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 diff --git a/doc/source/api/reference/consumers.rst b/doc/source/api/reference/consumers.rst index e698b895f..254dade7c 100644 --- a/doc/source/api/reference/consumers.rst +++ b/doc/source/api/reference/consumers.rst @@ -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: diff --git a/doc/source/api/reference/containers.rst b/doc/source/api/reference/containers.rst index ffe772efd..60e8d9497 100644 --- a/doc/source/api/reference/containers.rst +++ b/doc/source/api/reference/containers.rst @@ -56,7 +56,7 @@ Request: Response: -******** +********* .. code-block:: javascript diff --git a/doc/source/api/reference/orders.rst b/doc/source/api/reference/orders.rst index 4ffcef208..5c2ae4f28 100644 --- a/doc/source/api/reference/orders.rst +++ b/doc/source/api/reference/orders.rst @@ -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 | -+------+-----------------------------------------------------------------------------+ \ No newline at end of file ++------+-----------------------------------------------------------------------------+ diff --git a/doc/source/contribute/dataflow.rst b/doc/source/contribute/dataflow.rst index 060b8ca41..cf31fe0e4 100644 --- a/doc/source/contribute/dataflow.rst +++ b/doc/source/contribute/dataflow.rst @@ -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. diff --git a/doc/source/setup/noauth.rst b/doc/source/setup/noauth.rst index 6749fd263..0b260cc26 100644 --- a/doc/source/setup/noauth.rst +++ b/doc/source/setup/noauth.rst @@ -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 `_ and run barbican CLI in no auth mode -`here `_. +`here `__ and run barbican CLI in no auth mode +`here `__. diff --git a/doc/source/setup/troubleshooting.rst b/doc/source/setup/troubleshooting.rst index a22744a79..d4dea3f29 100644 --- a/doc/source/setup/troubleshooting.rst +++ b/doc/source/setup/troubleshooting.rst @@ -126,7 +126,7 @@ tests should run. Barbican's tox tests fail with "ImportError: No module named _bsddb" -------------------------------------------------- +-------------------------------------------------------------------- What you might see ^^^^^^^^^^^^^^^^^^