openstack/openstack-helm
Code Issues Proposed changes

Replace warnerror with warning-is-error

Browse Source 
"warnerrors" was broken in a previous version of [pbr] and most
projects have abandoned it for [sphinx] warning-is-error, which
provides the same functionality.[0] This change removes
"warnerrors" setting and adds the "warning-is-error" setting under
sphinx for enforcing strict documentation building.

Also added pbr>=3.0.0 as a test-requirement
since it contains a fix for invalid characters within commit
messages that can cause docs builds to fail when "warning-is-error"
is enabled.[1]

[0] http://lists.openstack.org/pipermail/openstack-dev/2017-March/113085.html
[1] http://lists.openstack.org/pipermail/openstack-dev/2017-April/115746.html

Change-Id: Ib80e3cca1826ef103d0cd8ec5a7f4cee84f04012
This commit is contained in:
Gage Hugo 2017-05-05 17:21:23 -05:00
parent 623c9f3429
commit 646cdf5f31
2 changed files with 2 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
setup.cfg
View File

@ -15,9 +15,7 @@ classifier =
all_files = 1
build-dir = doc/build
source-dir = doc/source
[pbr]
warnerrors = True
warning-is-error = True
[wheel]
universal = 1

2
test-requirements.txt
View File

@ -1,3 +1,3 @@
sphinx>=1.5.1 # BSD
oslosphinx>=4.7.0 # Apache-2.0
pbr>=3.0.0 # Apache-2.0