From 8d0a5a7fea70609e8b2a069dc3e50f32c75ddebf Mon Sep 17 00:00:00 2001
From: Akihiro Motoki <amotoki@gmail.com>
Date: Thu, 6 Jul 2017 21:02:55 +0000
Subject: [PATCH] Enable warning-is-error in doc build

- Fix docstring warnings
- pbr warnerrors is no longer needed.

Change-Id: I70532d99f34023b5fcce4373b6456cae2fbb642a
---
 oslo_vmware/hacking/checks.py    | 4 ++--
 oslo_vmware/objects/datastore.py | 3 ++-
 setup.cfg                        | 2 +-
 3 files changed, 5 insertions(+), 4 deletions(-)

diff --git a/oslo_vmware/hacking/checks.py b/oslo_vmware/hacking/checks.py
index b6d3ad9f..8591d71d 100644
--- a/oslo_vmware/hacking/checks.py
+++ b/oslo_vmware/hacking/checks.py
@@ -41,8 +41,8 @@ def no_translate_logs(logical_line, filename):
     :param logical_line: The logical line to check.
     :param filename: The file name where the logical line exists.
     :returns: None if the logical line passes the check, otherwise a tuple
-    is yielded that contains the offending index in logical line and a
-    message describe the check validation failure.
+        is yielded that contains the offending index in logical line and a
+        message describe the check validation failure.
     """
     if _log_translation_hint.match(logical_line):
         yield (0, "N537: Log messages should not be translated!")
diff --git a/oslo_vmware/objects/datastore.py b/oslo_vmware/objects/datastore.py
index 2966352d..c435fd5f 100644
--- a/oslo_vmware/objects/datastore.py
+++ b/oslo_vmware/objects/datastore.py
@@ -32,7 +32,7 @@ def get_datastore_by_ref(session, ds_ref):
 
     :param session: a vmware api session object
     :param ds_ref: managed object reference of a datastore
-    :rtype : a datastore object
+    :rtype: a datastore object
     """
     lst_properties = ["summary.type",
                       "summary.name",
@@ -195,6 +195,7 @@ class DatastorePath(object):
     file path to a virtual disk.
 
     Note:
+
     - Datastore path representations always uses forward slash as separator
       (hence the use of the posixpath module).
     - Datastore names are enclosed in square brackets.
diff --git a/setup.cfg b/setup.cfg
index c80d3614..f7338b51 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -26,6 +26,7 @@ packages =
 source-dir = doc/source
 build-dir = doc/build
 all_files = 1
+warning-is-error = 1
 
 [upload_sphinx]
 upload-dir = doc/build/html
@@ -46,7 +47,6 @@ output_file = oslo_vmware/locale/oslo_vmware.pot
 
 [pbr]
 autodoc_index_modules = 1
-warnerrors = True
 autodoc_exclude_modules =
     oslo_vmware._i18n
     oslo_vmware.tests.*