From e635f299656dbddf34eb5a8a8ed8476600f65c88 Mon Sep 17 00:00:00 2001 From: "bhavani.cr" Date: Tue, 27 Jun 2017 14:39:46 +0530 Subject: [PATCH] Remove pbr warnerrors in favor of sphinx check This change removes the now unused "warnerrors" setting, which is replaced by "warning-is-error" in sphinx releases >= 1.5[0]. This also fixes any warnings that came up when testing with the latest version of sphinx: - Redundant loading of todo extension - Empty man_pages config value Also updated the requirements for pbr and sphinx to the latest version(s) in requirements.txt With this change, any doc warnings will cause the build to fail [0] http://lists.openstack.org/pipermail/openstack-dev/2017-March/113085.html Change-Id: Id828161e866da6766d88ce553a3c5ea2593b8f84 --- doc/source/conf.py | 4 ---- requirements.txt | 4 ++-- setup.cfg | 2 ++ 3 files changed, 4 insertions(+), 6 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index d6cfb07..52bd18d 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -28,7 +28,6 @@ import os # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = ['sphinx.ext.autodoc', - 'sphinx.ext.todo', 'sphinx.ext.viewcode', 'oslosphinx', 'yasfb', @@ -93,9 +92,6 @@ pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. modindex_common_prefix = ['mogan-specs.'] -# -- Options for man page output ---------------------------------------------- -man_pages = [] - # -- Options for HTML output --------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for diff --git a/requirements.txt b/requirements.txt index 7d5e315..9584813 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,6 +1,6 @@ oslosphinx>=2.2.0.0a2 -pbr>=0.6,!=0.7,<1.0 -sphinx>=1.1.2,<1.2 +pbr>=2.0.0,!=2.1.0 +sphinx>=1.5.1,!=1.6.1 testrepository>=0.0.18 testtools>=0.9.34 yasfb>=0.5.1 diff --git a/setup.cfg b/setup.cfg index 540fd0b..bc90c9c 100644 --- a/setup.cfg +++ b/setup.cfg @@ -15,6 +15,8 @@ classifier = source-dir = doc/source build-dir = doc/build all_files = 1 +builders = html +warning-is-error = 1 [pbr] warnerrors = True