diff options
| author | Gage Hugo <gagehugo@gmail.com> | 2017-03-01 13:51:22 -0600 |
|---|---|---|
| committer | Gage Hugo <gagehugo@gmail.com> | 2017-04-24 16:31:00 -0500 |
| commit | 7e209b97675c1a2ba68c61f69d9f594d4c7b48e9 (patch) | |
| tree | 7048456638aa721cab0a3ade1864304c64170bcd | |
| parent | 9b14d80fe0519999cd801470573edfaf6991d6cd (diff) | |
| download | keystonemiddleware-7e209b97675c1a2ba68c61f69d9f594d4c7b48e9.tar.gz | |
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
| -rw-r--r-- | doc/source/conf.py | 1 | ||||
| -rw-r--r-- | setup.cfg | 1 |
2 files changed, 1 insertions, 1 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index a6eb2c4..cf7629d 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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', @@ -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 |