From 2e10d7b32cc32a2d367bbd38ec612fd283aaac8e Mon Sep 17 00:00:00 2001
From: Jim Rollenhagen <jim@jimrollenhagen.com>
Date: Thu, 7 Jul 2016 15:17:31 -0400
Subject: [PATCH] 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
---
doc/source/index.rst | 8 +++++++-
ironic_python_agent/extensions/iscsi.py | 2 +-
ironic_python_agent/hardware.py | 14 ++++++++------
ironic_python_agent/tests/functional/base.py | 10 +++++-----
4 files changed, 21 insertions(+), 13 deletions(-)
diff --git a/doc/source/index.rst b/doc/source/index.rst
index cbfdc6670..14b174838 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -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`
diff --git a/ironic_python_agent/extensions/iscsi.py b/ironic_python_agent/extensions/iscsi.py
index cf9c158a4..cdf232124 100644
--- a/ironic_python_agent/extensions/iscsi.py
+++ b/ironic_python_agent/extensions/iscsi.py
@@ -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:
diff --git a/ironic_python_agent/hardware.py b/ironic_python_agent/hardware.py
index 203245ddc..5755b5416 100644
--- a/ironic_python_agent/hardware.py
+++ b/ironic_python_agent/hardware.py
@@ -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
diff --git a/ironic_python_agent/tests/functional/base.py b/ironic_python_agent/tests/functional/base.py
index b47ecdf05..5267eb622 100644
--- a/ironic_python_agent/tests/functional/base.py
+++ b/ironic_python_agent/tests/functional/base.py
@@ -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