From 34b122cb067264382e10fafc9656f6cd778bfad5 Mon Sep 17 00:00:00 2001 From: Remco de Boer <29308176+redeboer@users.noreply.github.com> Date: Tue, 7 Mar 2023 18:03:13 +0100 Subject: [PATCH 1/3] MAINT: sort config keys in `tox.ini` --- tox.ini | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/tox.ini b/tox.ini index d1b17ea..8af6d43 100644 --- a/tox.ini +++ b/tox.ini @@ -9,16 +9,14 @@ envlist = sty, [testenv] -description = - Run all fast unit tests allowlist_externals = pytest commands = pytest {posargs:tests} +description = + Run all fast unit tests [testenv:cov] -description = - Compute the test coverage of all unit tests allowlist_externals = pytest commands = @@ -28,10 +26,10 @@ commands = --cov-report=xml \ --cov=boostcfg \ --cov=pawian +description = + Compute the test coverage of all unit tests [testenv:doc] -description = - Build documentation and API through Sphinx allowlist_externals = sphinx-build commands = @@ -41,10 +39,10 @@ commands = -TW \ -b html \ docs/ docs/_build/html +description = + Build documentation and API through Sphinx [testenv:doclive] -description = - Set up a server to preview changes to the HTML pages live allowlist_externals = sphinx-autobuild commands = @@ -56,24 +54,22 @@ commands = --re-ignore docs/api/.* \ --open-browser \ docs/ docs/_build/html +description = + Set up a server to preview changes to the HTML pages live [testenv:docnb] -description = - Execute Jupyter notebooks and build documentation with Sphinx allowlist_externals = sphinx-build +commands = + sphinx-build -nW --keep-going -b html docs/ docs/_build/html +description = + Execute Jupyter notebooks and build documentation with Sphinx passenv = TERM setenv = EXECUTE_NB = yes -commands = - sphinx-build -nW --keep-going -b html docs/ docs/_build/html [testenv:linkcheck] -description = - Check external links in the documentation (requires internet connection) -passenv = - EXECUTE_NB allowlist_externals = sphinx-build commands = @@ -82,11 +78,15 @@ commands = -T \ -b linkcheck \ docs/ docs/_build/linkcheck +description = + Check external links in the documentation (requires internet connection) +passenv = + EXECUTE_NB [testenv:sty] -description = - Perform all linting, formatting, and spelling checks allowlist_externals = pre-commit commands = pre-commit run {posargs} -a +description = + Perform all linting, formatting, and spelling checks From c54ce602d4b91ab258f3f4c1f86ea6a3870c69a1 Mon Sep 17 00:00:00 2001 From: Remco de Boer <29308176+redeboer@users.noreply.github.com> Date: Tue, 7 Mar 2023 18:03:14 +0100 Subject: [PATCH 2/3] DX: pass all environment variables in `tox` config --- tox.ini | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/tox.ini b/tox.ini index 8af6d43..61212c2 100644 --- a/tox.ini +++ b/tox.ini @@ -1,5 +1,4 @@ [tox] -passenv = PYTHONPATH skip_install = True skip_missing_interpreters=true skipsdist = True @@ -41,6 +40,7 @@ commands = docs/ docs/_build/html description = Build documentation and API through Sphinx +passenv = * [testenv:doclive] allowlist_externals = @@ -56,6 +56,7 @@ commands = docs/ docs/_build/html description = Set up a server to preview changes to the HTML pages live +passenv = * [testenv:docnb] allowlist_externals = @@ -64,8 +65,7 @@ commands = sphinx-build -nW --keep-going -b html docs/ docs/_build/html description = Execute Jupyter notebooks and build documentation with Sphinx -passenv = - TERM +passenv = * setenv = EXECUTE_NB = yes @@ -80,8 +80,7 @@ commands = docs/ docs/_build/linkcheck description = Check external links in the documentation (requires internet connection) -passenv = - EXECUTE_NB +passenv = * [testenv:sty] allowlist_externals = From 230e458486626feff1a4a8d95035efb4c1c4bf8d Mon Sep 17 00:00:00 2001 From: Remco de Boer <29308176+redeboer@users.noreply.github.com> Date: Tue, 7 Mar 2023 18:03:15 +0100 Subject: [PATCH 3/3] DX: show `sphinx-build` with color --- tox.ini | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/tox.ini b/tox.ini index 61212c2..81fb37e 100644 --- a/tox.ini +++ b/tox.ini @@ -41,6 +41,8 @@ commands = description = Build documentation and API through Sphinx passenv = * +setenv = + FORCE_COLOR = yes [testenv:doclive] allowlist_externals = @@ -57,6 +59,8 @@ commands = description = Set up a server to preview changes to the HTML pages live passenv = * +setenv = + FORCE_COLOR = yes [testenv:docnb] allowlist_externals = @@ -68,6 +72,7 @@ description = passenv = * setenv = EXECUTE_NB = yes + FORCE_COLOR = yes [testenv:linkcheck] allowlist_externals = @@ -81,6 +86,8 @@ commands = description = Check external links in the documentation (requires internet connection) passenv = * +setenv = + FORCE_COLOR = yes [testenv:sty] allowlist_externals =