Use sphinx keep-going option in tox jobs 29/100429/3
authorguillaume.lambert <guillaume.lambert@orange.com>
Wed, 6 Apr 2022 07:53:35 +0000 (09:53 +0200)
committerguillaume.lambert <guillaume.lambert@orange.com>
Wed, 6 Apr 2022 08:03:39 +0000 (10:03 +0200)
Without this option, sphinx stops at the first warning found
when -W option is enabled.
This prevents users from troubleshooting their contributions in 1 pass.

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

tox.ini

diff --git a/tox.ini b/tox.ini
index 69e2c714c35d6f6991a44b2d0a2ddc7c187d20e2..ad85799d31868e63e2301b675bfa31d2961f0419 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -7,7 +7,7 @@ skipsdist = true
 basepython = python3
 deps = -rdocs/requirements.txt
 commands =
-    sphinx-build -q -j auto -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
+    sphinx-build -q -j auto -W --keep-going -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
 
 [testenv:docs-linkcheck]
 basepython = python3
@@ -56,5 +56,5 @@ deps =
 whitelist_externals = sh
 commands =
     sh -c 'command enchant>/dev/null || command enchant-2 -v>/dev/null || sudo yum -y install enchant || (echo "enchant command not found - please install it (e.g. sudo apt-get install enchant | yum install enchant )" >&2 && exit 1)'
-    sphinx-build -q -W -b spelling -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spelling
+    sphinx-build -q -W --keep-going -b spelling -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spelling