From cde22bdddb73c61894d360ca9659de9837a77a03 Mon Sep 17 00:00:00 2001
From: jacky06 <zhang.min@99cloud.net>
Date: Mon, 14 Oct 2019 18:18:48 +0800
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: I405812a0039274139e055c54ab7b451dc753c842
---
 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 47988d6587..87c1fa5e6e 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -7,6 +7,6 @@
 # be installed in a specific order.
 openstackdocstheme>=1.19.0 # Apache-2.0
 reno>=2.5.0 # Apache-2.0
-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,!=2.1.0,>=1.6.2;python_version>='3.4'  # BSD
+sphinx>=1.8.0,<2.0.0;python_version=='2.7' # BSD
+sphinx>=1.8.0,!=2.1.0;python_version>='3.4'  # BSD
 sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
diff --git a/tox.ini b/tox.ini
index 44d0584605..b61402df9a 100644
--- a/tox.ini
+++ b/tox.ini
@@ -73,7 +73,7 @@ deps =
    -r{toxinidir}/doc/requirements.txt
 commands =
   rm -rf doc/build
-  sphinx-build -W -b html doc/source doc/build/html
+  sphinx-build -W --keep-going -b html doc/source doc/build/html
 
 [testenv:deploy-guide]
 basepython = python3
@@ -84,14 +84,14 @@ deps =
 
 commands =
   rm -rf deploy-guide/build
-  sphinx-build -a -E -W -d deploy-guide/build/doctrees -b html deploy-guide/source deploy-guide/build/html
+  sphinx-build -a -E -W -d deploy-guide/build/doctrees --keep-going -b html deploy-guide/source deploy-guide/build/html
 
 [testenv:pdf-docs]
 basepython = python3
 whitelist_externals = make
 deps = {[testenv:docs]deps}
 commands =
-  sphinx-build -W -b latex doc/source doc/build/pdf
+  sphinx-build -W --keep-going -b latex doc/source doc/build/pdf
   make -C doc/build/pdf
 
 [testenv:setupenv]
@@ -108,7 +108,7 @@ deps =
    -r{toxinidir}/doc/requirements.txt
 commands =
   rm -rf releasenotes/build
-  sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
+  sphinx-build -a -E -W -d releasenotes/build/doctrees --keep-going -b html releasenotes/source releasenotes/build/html
 
 [flake8]
 show-source = True