From 399db8a94e5dd62c1ba3f7f08e183e4405666517 Mon Sep 17 00:00:00 2001
From: jacky06 <zhang.min@99cloud.net>
Date: Thu, 24 Oct 2019 00:55:57 +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: I91d9104335ca7d432966b5c19f27dead6f8f57f1
---
tox.ini | 18 +++---------------
1 file changed, 3 insertions(+), 15 deletions(-)
diff --git a/tox.ini b/tox.ini
index 02cd865..ce7f094 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 -W --keep-going -b html doc/source doc/build/html
[testenv:pdf-docs]
basepython = python3
@@ -47,7 +44,7 @@ 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
@@ -55,13 +52,11 @@ commands =
# 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,43 +64,36 @@ 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"
-
[testenv:functional]
commands =
bash -c "{toxinidir}/tests/common/test-ansible-functional.sh"
-
[testenv:linters]
basepython = python3
commands =