From eb10545b372a936aa551acf03eebd250318aa3a5 Mon Sep 17 00:00:00 2001
From: caoyuan <cao.yuan@99cloud.net>
Date: Thu, 24 Oct 2019 19:31:18 +0800
Subject: [PATCH] tox: Keeping going with docs

1. 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.

2. Add whitelist_externals to fix the warning

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

Change-Id: I47683ab1313981a8202afe6b3fe1779d40340452
---
 doc/requirements.txt |  4 ++--
 tox.ini              | 12 +++++++++---
 2 files changed, 11 insertions(+), 5 deletions(-)

diff --git a/doc/requirements.txt b/doc/requirements.txt
index 57ca58cd60..286a4733fd 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -4,8 +4,8 @@
 
 openstackdocstheme>=1.20.0 # Apache-2.0
 os-api-ref>=1.4.0 # Apache-2.0
-sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD
-sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD
+sphinx>=1.8.0,!=2.1.0;python_version>='3.4' # BSD
+sphinx>=1.8.0,<2.0.0;python_version=='2.7' # BSD
 reno>=2.5.0 # Apache-2.0
 sphinxcontrib-apidoc>=0.2.0 # BSD
 sphinxcontrib-httpdomain>=1.3.0 # BSD
diff --git a/tox.ini b/tox.ini
index 596d9f30be..17bf4c83fa 100644
--- a/tox.ini
+++ b/tox.ini
@@ -66,10 +66,12 @@ commands =
 
 [testenv:docs]
 basepython = python3
+whitelist_externals =
+  rm
 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:api-ref]
 basepython = python3
@@ -80,7 +82,7 @@ whitelist_externals = bash
                       rm
 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:genconfig]
 basepython = python3
@@ -130,8 +132,12 @@ commands = oslo_debug_helper {posargs}
 
 [testenv:releasenotes]
 basepython = python3
+whitelist_externals =
+  rm
 deps = -r{toxinidir}/doc/requirements.txt
-commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
+commands =
+  rm -rf releasenotes/build
+  sphinx-build -a -E -W -d releasenotes/build/doctrees --keep-going -b html releasenotes/source releasenotes/build/html
 
 [testenv:bindep]
 basepython = python3