openstack/swift
Code Issues Proposed changes

Merge "Turn on warning-is-error in doc build"

Browse Source
This commit is contained in:
Jenkins 2017-08-08 03:33:14 +00:00 committed by Gerrit Code Review
commit f7c55c169a
3 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/conf.py
View File

@ -27,10 +27,20 @@
# serve to show the default. # serve to show the default.
import datetime import datetime
import logging
import os import os
from swift import __version__ from swift import __version__
import sys 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, # 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 # 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. # documentation root, use os.path.abspath to make it absolute, like shown here.

1
setup.cfg
View File

@ -105,6 +105,7 @@ paste.filter_factory =
all_files = 1 all_files = 1
build-dir = doc/build build-dir = doc/build
source-dir = doc/source source-dir = doc/source
warning-is-error = 1
[egg_info] [egg_info]
tag_build = tag_build =