From 792f1c5640304b9e4620056f8aba6d56b884295c Mon Sep 17 00:00:00 2001
From: jacky06 <zhang.min@99cloud.net>
Date: Thu, 24 Oct 2019 01:22:59 +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. Remove the unnecessary blank line for tox.ini

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

Depends-On: Ie837d376bb1a1d93367369d25140dd8a9d5ac14e
Change-Id: Iec29a958241b65cb3f7e8933169a6e55c6a39656
---
 tox.ini | 24 +++---------------------
 1 file changed, 3 insertions(+), 21 deletions(-)

diff --git a/tox.ini b/tox.ini
index 8555199..19dc652 100644
--- a/tox.ini
+++ b/tox.ini
@@ -3,7 +3,6 @@ minversion = 2.0
 skipsdist = True
 envlist = docs,linters,functional
 
-
 [testenv]
 usedevelop = True
 install_command =
@@ -31,15 +30,13 @@ setenv =
     VIRTUAL_ENV={envdir}
     WORKING_DIR={toxinidir}
 
-
 [testenv:docs]
 basepython = python3
 deps = -r{toxinidir}/doc/requirements.txt
 commands =
     bash -c "rm -rf doc/build"
     doc8 doc
-    sphinx-build -b html doc/source doc/build/html
-
+    sphinx-build --keep-going -b html doc/source doc/build/html
 
 [testenv:pdf-docs]
 basepython = python3
@@ -47,21 +44,18 @@ deps = {[testenv:docs]deps}
 whitelist_externals =
   make
 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
 
-
 [doc8]
 # Settings for doc8:
 extensions = .rst
 
-
 [testenv:releasenotes]
 basepython = python3
 deps = -r{toxinidir}/doc/requirements.txt
 commands =
-    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
 
 # environment used by the -infra templated docs job
 [testenv:venv]
@@ -69,38 +63,32 @@ basepython = python3
 commands =
     {posargs}
 
-
 [testenv:pep8]
 basepython = python3
 commands =
     bash -c "{toxinidir}/tests/common/test-pep8.sh"
 
-
 [flake8]
 # Ignores the following rules due to how ansible modules work in general
 #     F403 'from ansible.module_utils.basic import *' used;
 #          unable to detect undefined names
 ignore=F403
 
-
 [testenv:bashate]
 basepython = python3
 commands =
     bash -c "{toxinidir}/tests/common/test-bashate.sh"
 
-
 [testenv:ansible-syntax]
 basepython = python3
 commands =
     bash -c "{toxinidir}/tests/common/test-ansible-syntax.sh"
 
-
 [testenv:ansible-lint]
 basepython = python3
 commands =
     bash -c "{toxinidir}/tests/common/test-ansible-lint.sh"
 
-
 # Functional testing for BTRFS backed containers
 [testenv:btrfs]
 setenv =
@@ -109,7 +97,6 @@ setenv =
 commands =
     bash -c "{toxinidir}/tests/common/test-ansible-functional.sh"
 
-
 # Functional testing for Directory backed containers
 [testenv:dir]
 setenv =
@@ -118,7 +105,6 @@ setenv =
 commands =
     bash -c "{toxinidir}/tests/common/test-ansible-functional.sh"
 
-
 # Functional testing for machinectl backed containers
 [testenv:mnctl]
 setenv =
@@ -127,7 +113,6 @@ setenv =
 commands =
     bash -c "{toxinidir}/tests/common/test-ansible-functional.sh"
 
-
 # Functional testing for OverlayFS backed containers
 [testenv:ofs]
 setenv =
@@ -136,7 +121,6 @@ setenv =
 commands =
     bash -c "{toxinidir}/tests/common/test-ansible-functional.sh"
 
-
 # Functional testing for ZFS backed containers
 [testenv:zfs]
 setenv =
@@ -145,14 +129,12 @@ setenv =
 commands =
     bash -c "{toxinidir}/tests/common/test-ansible-functional.sh"
 
-
 [testenv:functional]
 setenv =
     {[testenv:dir]setenv}
 commands =
     {[testenv:dir]commands}
 
-
 [testenv:linters]
 basepython = python3
 commands =