From cfcf9ef798ab5241e223def332e8d7fe2dfca884 Mon Sep 17 00:00:00 2001 From: Gage Hugo Date: Fri, 3 Mar 2017 14:45:35 -0600 Subject: Remove pbr warnerrors in favor of sphinx check This change removes the unused "warnerrors" setting that was part of [pbr], which was replaced by "warning-is-error" in sphinx 1.5 and above[0]. This also fixes any warnings and errors that came up when running `tox -edocs` using this new feature: - Specified correct instance of 'List' This change also adds the "warning-is-error" setting to setup.cfg in order to allow for strict doc validation which will cause doc building to fail if any warnings are thrown. [0] http://lists.openstack.org/pipermail/openstack-dev/2017-March/113085.html Change-Id: I8111193e5a1ae7d063ab4cc37186aea1299964a4 --- keystoneclient/exceptions.py | 2 +- setup.cfg | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/keystoneclient/exceptions.py b/keystoneclient/exceptions.py index 2e3270a..5b06be9 100644 --- a/keystoneclient/exceptions.py +++ b/keystoneclient/exceptions.py @@ -415,7 +415,7 @@ An alias of :py:exc:`keystoneauth1.exceptions.auth_plugins.NoMatchingPlugin` class UnsupportedParameters(ClientException): """A parameter that was provided or returned is not supported. - :param list(str) names: Names of the unsupported parameters. + :param List(str) names: Names of the unsupported parameters. .. py:attribute:: names diff --git a/setup.cfg b/setup.cfg index 9e913a7..e1e9851 100644 --- a/setup.cfg +++ b/setup.cfg @@ -40,9 +40,9 @@ keystoneclient.auth.plugin = source-dir = doc/source build-dir = doc/build all_files = 1 +warning-is-error = 1 [pbr] -warnerrors = True autodoc_tree_index_modules = True autodoc_tree_excludes = setup.py -- cgit v1.2.1