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
This commit is contained in:
bhavani.cr 2017-06-27 14:39:46 +05:30
parent 5f58e34f1e
commit e635f29965
3 changed files with 4 additions and 6 deletions

View File

@ -28,7 +28,6 @@ import os
# Add any Sphinx extension module names here, as strings. They can be extensions # Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', extensions = ['sphinx.ext.autodoc',
'sphinx.ext.todo',
'sphinx.ext.viewcode', 'sphinx.ext.viewcode',
'oslosphinx', 'oslosphinx',
'yasfb', 'yasfb',
@ -93,9 +92,6 @@ pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting. # A list of ignored prefixes for module index sorting.
modindex_common_prefix = ['mogan-specs.'] modindex_common_prefix = ['mogan-specs.']
# -- Options for man page output ----------------------------------------------
man_pages = []
# -- Options for HTML output --------------------------------------------------- # -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for

View File

@ -1,6 +1,6 @@
oslosphinx>=2.2.0.0a2 oslosphinx>=2.2.0.0a2
pbr>=0.6,!=0.7,<1.0 pbr>=2.0.0,!=2.1.0
sphinx>=1.1.2,<1.2 sphinx>=1.5.1,!=1.6.1
testrepository>=0.0.18 testrepository>=0.0.18
testtools>=0.9.34 testtools>=0.9.34
yasfb>=0.5.1 yasfb>=0.5.1

View File

@ -15,6 +15,8 @@ classifier =
source-dir = doc/source source-dir = doc/source
build-dir = doc/build build-dir = doc/build
all_files = 1 all_files = 1
builders = html
warning-is-error = 1
[pbr] [pbr]
warnerrors = True warnerrors = True