CI: treat warnings as error in docs tox job 32/97532/1
authorguillaume.lambert <guillaume.lambert@orange.com>
Mon, 20 Sep 2021 09:27:09 +0000 (11:27 +0200)
committerguillaume.lambert <guillaume.lambert@orange.com>
Mon, 20 Sep 2021 09:27:20 +0000 (11:27 +0200)
The previous commit fixed the last remaining warning in the docs job.
Adding in this job the option -W to sphinx will make it treat warnings
as error and will ensure there won't be anymore docs warnings that
pollutes jenkins logs in the future.

Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com>
Change-Id: I5101eceb98aa2bb0ef8b922d871b8e68af0893ef

tox.ini

diff --git a/tox.ini b/tox.ini
index 0bce156ffe23efd391c7204678bb433359d9e4ea..51b2a72fa1b949057f2dd92dca5fa6d664c23733 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -5,7 +5,7 @@ skipsdist = true
 
 [testenv:docs]
 deps = -rdocs/requirements.txt
-commands = sphinx-build -b html -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
+commands = sphinx-build -W -b html -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
 
 [testenv:jenkins-jobs]
 deps =