Use Sphinx 1.5 warning-is-error

With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section. Enable this.

Change-Id: I981b05275e1a75e3c42ea3ef24812cded0cefc0d
This commit is contained in:
Stephen Finucane 2017-04-19 10:52:05 +01:00 committed by Dougal Matthews
parent 1e260a1c86
commit 3653a6006f
4 changed files with 9 additions and 5 deletions

View File

@ -50,6 +50,8 @@ add_module_names = True
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
suppress_warnings = ['image.nonlocal_uri']
# -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. Major themes that come with
@ -70,6 +72,3 @@ latex_documents = [
u'%s Documentation' % project,
u'OpenStack Foundation', 'manual'),
]
# Example configuration for intersphinx: refer to the Python standard library.
#intersphinx_mapping = {'http://docs.python.org/': None}

View File

@ -1 +1,4 @@
.. include:: ../../CONTRIBUTING.rst
Contributing
============
.. include:: ../../CONTRIBUTING.rst

View File

@ -11,6 +11,7 @@ Contents:
readme
installation
usage
command-list
contributing

View File

@ -27,9 +27,10 @@ packages =
[build_sphinx]
builders = html,man
all-files = 1
warning-is-error = 1
source-dir = doc/source
build-dir = doc/build
all_files = 1
[upload_sphinx]
upload-dir = doc/build/html