From 8629b628cb1d9bd6ae90f5e6c58e8eab99c2aa50 Mon Sep 17 00:00:00 2001 From: Akihiro Motoki Date: Sat, 8 Jul 2017 22:36:15 +0000 Subject: [PATCH] turn on warning-is-error in doc build sphinx.ext.napoleon is a preprocessor which converts Google style docstring into ReST style. This is required to avoid sphinx warnings. warnerrors = True in [pbr] section is no longer needed in favor of warning-is-error in sphinx. Change-Id: If4a7adfae5dab3313bb54ad465a75290476b7154 --- doc/source/conf.py | 1 + setup.cfg | 4 +--- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 92acd31..90d7516 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -22,6 +22,7 @@ sys.path.insert(0, os.path.abspath('../..')) extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.doctest', + 'sphinx.ext.napoleon', 'openstackdocstheme', ] diff --git a/setup.cfg b/setup.cfg index 3e004cf..a04bb55 100644 --- a/setup.cfg +++ b/setup.cfg @@ -26,6 +26,7 @@ packages = source-dir = doc/source build-dir = doc/build all_files = 1 +warning-is-error = 1 [upload_sphinx] upload-dir = doc/build/html @@ -34,9 +35,6 @@ upload-dir = doc/build/html directory = futurist/locale domain = futurist -[pbr] -warnerrors = True - [wheel] universal = 1