From 674d8052600b92ee85405af38f3c65f19a892871 Mon Sep 17 00:00:00 2001 From: Sean McGinnis Date: Mon, 8 Jan 2018 11:41:21 -0600 Subject: [PATCH] Treat doc warnings as errors This adds a flag to the sphinx-build command to treat warnings as errors. It also cleans out the old doc related entries from setup.cfg since docs are no longer built using that method. Change-Id: I1bacf231605ab791d4b817223ab64be2a4133672 --- setup.cfg | 9 --------- tox.ini | 2 +- 2 files changed, 1 insertion(+), 10 deletions(-) diff --git a/setup.cfg b/setup.cfg index da88228..de2e33b 100644 --- a/setup.cfg +++ b/setup.cfg @@ -27,14 +27,5 @@ console_scripts = oslo-rootwrap = oslo_rootwrap.cmd:main oslo-rootwrap-daemon = oslo_rootwrap.cmd:daemon -[build_sphinx] -source-dir = doc/source -build-dir = doc/build -all_files = 1 -warning-is-error = 1 - -[upload_sphinx] -upload-dir = doc/build/html - [wheel] universal = 1 diff --git a/tox.ini b/tox.ini index c152eca..51e91a4 100644 --- a/tox.ini +++ b/tox.ini @@ -35,7 +35,7 @@ commands = {posargs} [testenv:docs] deps = -r{toxinidir}/doc/requirements.txt -commands = sphinx-build -b html doc/source doc/build/html +commands = sphinx-build -W -b html doc/source doc/build/html [flake8] show-source = True