Fix doc warnings

Per Doug's email[0], 'warnerrors' in setup.cfg hasn't actually been
working for some time now, and we've piled up a few warnings. Fix these
before a pbr release to unbreak it gets pushed out and breaks our doc
builds.

[0] http://lists.openstack.org/pipermail/openstack-dev/2016-June/097849.html

Change-Id: I6576a56234918febb21e7e4860544eb952123c09
This commit is contained in:
Jim Rollenhagen 2016-07-07 15:17:31 -04:00
parent b139dccf3c
commit 2e10d7b32c
4 changed files with 21 additions and 13 deletions
doc/source
ironic_python_agent
extensions
hardware.py
tests/functional

@ -12,6 +12,13 @@ provisioning servers.
Throughout the remainder of the document, Ironic Python Agent will be
abbreviated to IPA.
Index
=====
.. toctree::
troubleshooting
How it works
============
@ -350,4 +357,3 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
* :ref:`troubleshooting`

@ -151,7 +151,7 @@ class ISCSIExtension(base.BaseAgentExtension):
"""Expose the disk as an ISCSI target.
:param wipe_disk_metadata: if the disk metadata should be wiped out
before the disk is exposed.
before the disk is exposed.
"""
# If iqn is not given, generate one
if iqn is None:

@ -354,12 +354,14 @@ class HardwareManager(object):
If multiple hardware managers return the same step name, the following
logic will be used to determine which manager's step "wins":
- Keep the step that belongs to HardwareManager with highest
HardwareSupport (larger int) value.
- If equal support level, keep the step with the higher defined
priority (larger int).
- If equal support level and priority, keep the step associated
with the HardwareManager whose name comes earlier in the alphabet.
* Keep the step that belongs to HardwareManager with highest
HardwareSupport (larger int) value.
* If equal support level, keep the step with the higher defined
priority (larger int).
* If equal support level and priority, keep the step associated
with the HardwareManager whose name comes earlier in the
alphabet.
The steps will be called using `hardware.dispatch_to_managers` and
handled by the best suited hardware manager. If you need a step to be

@ -71,13 +71,13 @@ class FunctionalBase(test_base.BaseTestCase):
**kwargs):
"""Send a request to the agent and verifies response.
:param: method type of request to send as a string
:param: path desired API endpoint to request, for example 'commands'
:param: expect_error error code to expect, if an error is expected
:param: expect_json whether to expect a JSON response. if True, convert
:param method: type of request to send as a string
:param path: desired API endpoint to request, for example 'commands'
:param expect_error: error code to expect, if an error is expected
:param expect_json: whether to expect a JSON response. if True, convert
it to a dict before returning, otherwise return the
Response object
:param **kwargs: keyword args to pass to the request method
:param kwargs: keyword args to pass to the request method
:raises: HTTPError if an error is returned that was not expected
:raises: AssertionError if a received HTTP status code does not match
expect_error