From 886d8c6dabc05937be9fbec840fc3849badc55cd Mon Sep 17 00:00:00 2001
From: Stephen Finucane <sfinucan@redhat.com>
Date: Thu, 16 Mar 2017 15:42:44 +0000
Subject: [PATCH] Use Sphinx 1.5 warning-is-error

With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section.  Migrate the
setting from the old warnerrors one.

There are some invalid docstrings. These are cleaned up.

Change-Id: Ic6a028bab428b23255f36e5b2d64ee8d4d32978d
---
 oslo_policy/policy.py | 26 ++++++++++++++------------
 setup.cfg             |  7 +++++--
 2 files changed, 19 insertions(+), 14 deletions(-)

diff --git a/oslo_policy/policy.py b/oslo_policy/policy.py
index 2abb4be7..4a5a8796 100644
--- a/oslo_policy/policy.py
+++ b/oslo_policy/policy.py
@@ -127,10 +127,11 @@ attributes obtained through a token:
     - domain_id or project_id (depending on the token scope)
     - list of roles held for the given token scope
 
-.. note:: Some resources which are exposed by the API do not support policy
-enforcement by user_id, and only support policy enforcement by project_id.
-Some global resources do not support policy enforcement by combination of
-user_id and project_id.
+.. note::
+   Some resources which are exposed by the API do not support policy
+   enforcement by user_id, and only support policy enforcement by project_id.
+   Some global resources do not support policy enforcement by combination of
+   user_id and project_id.
 
 For example, a check on the user_id would be defined as::
 
@@ -204,10 +205,10 @@ using the :func:`~oslo_policy.policy.register` function.
 
 The following classes can be used as parents for custom special check types:
 
-    * :class:`~oslo_policy.policy.AndCheck`
-    * :class:`~oslo_policy.policy.NotCheck`
-    * :class:`~oslo_policy.policy.OrCheck`
-    * :class:`~oslo_policy.policy.RuleCheck`
+* :class:`~oslo_policy.policy.AndCheck`
+* :class:`~oslo_policy.policy.NotCheck`
+* :class:`~oslo_policy.policy.OrCheck`
+* :class:`~oslo_policy.policy.RuleCheck`
 
 Default Rule
 ~~~~~~~~~~~~
@@ -851,11 +852,12 @@ class DocumentedRuleDefault(RuleDefault):
     converted to use DocumentedRuleDefault.
 
     :param operations: List of dicts containing each api url and
-                       corresponding http request method.
+        corresponding http request method.
 
-                       Example:
-                       operations=[{'path': '/foo', 'method': 'GET'},
-                                   {'path': '/some', 'method': 'POST'}]
+        Example::
+
+            operations=[{'path': '/foo', 'method': 'GET'},
+                        {'path': '/some', 'method': 'POST'}]
     """
     def __init__(self, name, check_str, description, operations):
         super(DocumentedRuleDefault, self).__init__(
diff --git a/setup.cfg b/setup.cfg
index f0ea9d8d..cfa04766 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -23,8 +23,10 @@ packages =
     oslo_policy
 
 [pbr]
-warnerrors = true
 autodoc_tree_index_modules = True
+autodoc_tree_excludes =
+    setup.py
+    oslo_policy/tests/
 
 [entry_points]
 oslo.config.opts =
@@ -37,9 +39,10 @@ console_scripts =
     oslopolicy-list-redundant = oslo_policy.generator:list_redundant
 
 [build_sphinx]
+all-files = 1
+warning-is-error = 1
 source-dir = doc/source
 build-dir = doc/build
-all_files = 1
 
 [upload_sphinx]
 upload-dir = doc/build/html