openstack
/
keystonemiddleware
Code Issues Proposed changes

Added "warning-is-error" sphinx check for docs 

This change adds the "warning-is-error" setting
to setup.cfg in order to enforce strict doc validation which
will cause the build to fail if any warnings are thrown.

This also removes the redundant loading of the todo plugin
warning that shows up while running 'tox -e docs' with
'warning-is-error' enabled.

Change-Id: I33c110073feec7dd38ab75981d6f97c654852f37
This commit is contained in:
Gage Hugo 2017-03-01 13:51:22 -06:00
parent 9b14d80fe0
commit 7e209b9767
2 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/conf.py
View File

@ -40,7 +40,6 @@ sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__),
# extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.intersphinx',
'oslosphinx',

1
setup.cfg
View File

@ -44,6 +44,7 @@ paste.filter_factory =
source-dir = doc/source
build-dir = doc/build
all_files = 1
warning-is-error = 1
[pbr]
autodoc_tree_index_modules = True