From 646cdf5f312155de70958cb3de856cd11aff742f Mon Sep 17 00:00:00 2001 From: Gage Hugo Date: Fri, 5 May 2017 17:21:23 -0500 Subject: [PATCH] Replace warnerror with warning-is-error "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 --- setup.cfg | 4 +--- test-requirements.txt | 2 +- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/setup.cfg b/setup.cfg index 1a9e6eec6c..d6ec907d9c 100644 --- a/setup.cfg +++ b/setup.cfg @@ -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 diff --git a/test-requirements.txt b/test-requirements.txt index 6091fdc2bc..3a1dc427db 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,3 +1,3 @@ sphinx>=1.5.1 # BSD oslosphinx>=4.7.0 # Apache-2.0 - +pbr>=3.0.0 # Apache-2.0