openstack/neutron-lib
Code Issues Proposed changes

Enable warning-is-error in doc build

Browse Source 
The command to build docs is updated to match that run in the gate.
The previous command is to ensure no warning, but sphinx 1.5 or later
has warning-is-error option and there is no need to run a different
command in tox docs target.

Change-Id: Ieac8afd096a158aff6403326104ced31adcb77e1
This commit is contained in:
Akihiro Motoki
2017-07-05 06:49:58 +09:00
parent d52cb5f1e2
commit 94d7e681ee
2 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
setup.cfg
View File

@@ -26,6 +26,7 @@ packages =
source-dir = doc/source source-dir = doc/source
build-dir = doc/build build-dir = doc/build
all_files = 1 all_files = 1
warning-is-error = 1
[upload_sphinx] [upload_sphinx]
upload-dir = doc/build/html upload-dir = doc/build/html

2
tox.ini
View File

@@ -33,7 +33,7 @@ commands =
coverage report coverage report
[testenv:docs] [testenv:docs]
commands = sphinx-build -W -b html doc/source doc/build/html commands = python setup.py build_sphinx
[testenv:api-ref] [testenv:api-ref]
whitelist_externals = rm whitelist_externals = rm