From 81dff47a190bea2e550fb9fcc061d0a45e22a617 Mon Sep 17 00:00:00 2001
From: Stephen Finucane <sfinucan@redhat.com>
Date: Thu, 11 Jul 2019 15:51:30 +0100
Subject: [PATCH] tox: Keeping going with docs

Sphinx 1.8 introduced [1] the '--keep-going' argument which, as its name
suggests, keeps the build running when it encounters non-fatal errors.
This is exceptionally useful in avoiding a continuous edit-build loop
when undertaking large doc reworks where multiple errors may be
introduced.

[1] https://github.com/sphinx-doc/sphinx/commit/e3483e9b045

Change-Id: Idc38751e1629947f5842651d99b1528f74247b42
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
---
 doc/requirements.txt | 4 ++--
 tox.ini              | 8 ++++----
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/doc/requirements.txt b/doc/requirements.txt
index 3bc43d205279..c134946f81ca 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,8 +1,8 @@
 # The order of packages is significant, because pip processes them in the order
 # of appearance. Changing the order has an impact on the overall integration
 # process, which may cause wedges in the gate later.
-sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD
-sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4'  # BSD
+sphinx>=1.8.0,<2.0.0;python_version=='2.7' # BSD
+sphinx>=1.8.0;python_version>='3.4'  # BSD
 sphinxcontrib-actdiag>=0.8.5 # BSD
 sphinxcontrib-seqdiag>=0.8.4 # BSD
 sphinx-feature-classification>=0.2.0 # Apache-2.0
diff --git a/tox.ini b/tox.ini
index e31a70dcd7c3..7bbfecec7ac9 100644
--- a/tox.ini
+++ b/tox.ini
@@ -172,7 +172,7 @@ commands =
   bash -c "! find doc/ -type f -name *.json | xargs grep -U -n $'\r'"
   # Check that all included JSON files are valid JSON
   bash -c '! find doc/ -type f -name *.json | xargs -t -n1 python -m json.tool 2>&1 > /dev/null | grep -B1 -v ^python'
-  sphinx-build -W -b html -d doc/build/doctrees doc/source doc/build/html
+  sphinx-build -W --keep-going -b html -d doc/build/doctrees doc/source doc/build/html
   # Test the redirects. This must run after the main docs build
   whereto doc/build/html/.htaccess doc/test/redirect-tests.txt
 
@@ -183,7 +183,7 @@ envdir = {toxworkdir}/docs
 deps = {[testenv:docs]deps}
 commands =
   rm -rf api-guide/build
-  sphinx-build -W -b html -d api-guide/build/doctrees api-guide/source api-guide/build/html
+  sphinx-build -W --keep-going -b html -d api-guide/build/doctrees api-guide/source api-guide/build/html
 
 [testenv:api-ref]
 description =
@@ -192,7 +192,7 @@ envdir = {toxworkdir}/docs
 deps = {[testenv:docs]deps}
 commands =
   rm -rf api-ref/build
-  sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html
+  sphinx-build -W --keep-going -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html
 
 [testenv:releasenotes]
 description =
@@ -201,7 +201,7 @@ envdir = {toxworkdir}/docs
 deps = {[testenv:docs]deps}
 commands =
   rm -rf releasenotes/build
-  sphinx-build -W -b html -d releasenotes/build/doctrees releasenotes/source releasenotes/build/html
+  sphinx-build -W --keep-going -b html -d releasenotes/build/doctrees releasenotes/source releasenotes/build/html
 
 [testenv:all-docs]
 description =