openstack
/
python-keystoneclient
Code Issues Proposed changes

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
This commit is contained in:
Gage Hugo 2017-03-03 14:45:35 -06:00
parent 4c88af5ae1
commit cfcf9ef798
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
keystoneclient/exceptions.py
View File

@ -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

2
setup.cfg
View File

@ -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