diff --git a/doc/source/conf.py b/doc/source/conf.py index bc260c1bbe..922ad33dd5 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -27,10 +27,20 @@ # serve to show the default. import datetime +import logging import os from swift import __version__ import sys +# NOTE(amotoki): Our current doc build job uses an older version of +# liberasurecode which comes from Ubuntu 16.04. +# pyeclib emits a warning message if liberasurecode <1.3.1 is used [1] and +# this causes the doc build failure if warning-is-error is enabled in Sphinx. +# As a workaround we suppress the warning message from pyeclib until we use +# a newer version of liberasurecode in our doc build job. +# [1] https://github.com/openstack/pyeclib/commit/d163972b +logging.getLogger('pyeclib').setLevel(logging.ERROR) + # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. diff --git a/doc/source/howto_installmultinode.rst b/doc/source/howto_installmultinode.rst index 4116d8bac3..af5b45194d 100644 --- a/doc/source/howto_installmultinode.rst +++ b/doc/source/howto_installmultinode.rst @@ -10,6 +10,6 @@ Current Install Guides ---------------------- * `Object Storage installation guide for OpenStack Ocata - `__ + `__ * `Object Storage installation guide for OpenStack Newton - `__ + `__ diff --git a/setup.cfg b/setup.cfg index 274a22eb65..735c518d71 100644 --- a/setup.cfg +++ b/setup.cfg @@ -105,6 +105,7 @@ paste.filter_factory = all_files = 1 build-dir = doc/build source-dir = doc/source +warning-is-error = 1 [egg_info] tag_build =