From 3653a6006f747c6d626a4173886faed93f4f4b93 Mon Sep 17 00:00:00 2001
From: Stephen Finucane <sfinucan@redhat.com>
Date: Wed, 19 Apr 2017 10:52:05 +0100
Subject: [PATCH] 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
---
 doc/source/conf.py          | 5 ++---
 doc/source/contributing.rst | 5 ++++-
 doc/source/index.rst        | 1 +
 setup.cfg                   | 3 ++-
 4 files changed, 9 insertions(+), 5 deletions(-)

diff --git a/doc/source/conf.py b/doc/source/conf.py
index 06e65f6c5..905b78fff 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -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}
\ No newline at end of file
diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst
index 8cb3146fe..a1d5a6e16 100644
--- a/doc/source/contributing.rst
+++ b/doc/source/contributing.rst
@@ -1 +1,4 @@
-.. include:: ../../CONTRIBUTING.rst
\ No newline at end of file
+Contributing
+============
+
+.. include:: ../../CONTRIBUTING.rst
diff --git a/doc/source/index.rst b/doc/source/index.rst
index ac817e64c..aa7129829 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -11,6 +11,7 @@ Contents:
 
    readme
    installation
+   usage
    command-list
    contributing
 
diff --git a/setup.cfg b/setup.cfg
index e3569b7cc..76df2c626 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -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