From 6c362ce53ef0082b5e5b66b5a3b5d492bb6ecdaf Mon Sep 17 00:00:00 2001 From: csatari Date: Thu, 13 Jul 2017 10:11:15 +0200 Subject: [PATCH] Adding warning-is-error to doc building As it is required in [1] warning-is-error should be set for doc building. This change sets the flag and corrects the warnings. [1]: http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html Change-Id: Ia93fd13645830cd8994ef283b72f31cb22cf3fe9 Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Signed-off-by: csatari --- doc/source/conf.py | 3 +++ setup.cfg | 1 + 2 files changed, 4 insertions(+) diff --git a/doc/source/conf.py b/doc/source/conf.py index 01e1d4349..8cb3eab23 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -29,12 +29,15 @@ sys.path.insert(0, os.path.abspath('./')) extensions = [ 'sphinx.ext.autodoc', 'sphinxcontrib.pecanwsme.rest', + 'sphinxcontrib.httpdomain', 'wsmeext.sphinxext', 'openstackdocstheme', ] wsme_protocols = ['restjson'] +suppress_warnings = ['app.add_directive'] + # Add any paths that contain templates here, relative to this directory. # templates_path = ['_templates'] diff --git a/setup.cfg b/setup.cfg index e7c7eb7ba..92a8d0ebc 100644 --- a/setup.cfg +++ b/setup.cfg @@ -28,6 +28,7 @@ packages = source-dir = doc/source build-dir = doc/build all_files = 1 +warning-is-error = 1 [upload_sphinx] upload-dir = doc/build/html