opendev/storyboard
Code Issues Proposed changes

treat doc build warnings as errors

Browse Source 
Turn on the flag to cause documentation build warnings to be treated
as errors.

Change-Id: I0135d905cc77dfe30b06093d18e0883f8227bd85
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
Doug Hellmann 2018-01-17 13:34:36 -05:00
parent 833fdea9e5
commit a8dbce772c
2 changed files with 2 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
setup.cfg
View File

@ -43,6 +43,7 @@ storyboard.plugin.scheduler =
token-cleaner = storyboard.plugin.token_cleaner.cleaner:TokenCleaner
[build_sphinx]
warning-is-error = 1
source-dir = doc/source
build-dir = doc/build
all_files = 1

5
tox.ini
View File

@ -29,10 +29,7 @@ deps = -r{toxinidir}/doc/requirements.txt
commands =
rm -rf doc/html doc/build
rm -rf doc/source/apidoc doc/source/api
# NOTE(dhellmann): We cannot use -W with sphinx-build because the
# wsme.sphinxext registers a directive that is already registered
# and that warning causes the build to exit.
sphinx-build -b html doc/source doc/build/html
sphinx-build -W -b html doc/source doc/build/html
[testenv:cover]
commands = python setup.py testr --coverage --testr-args='{posargs}'