Skip to content

Commit bd498d4

Browse files
committed
DOC: Improve tox.ini documentation
1 parent bac556d commit bd498d4

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

tox.ini

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# This file encodes a lot of our intended support range, as well as some
2+
# details about dependency availability.
3+
#
4+
# The majority of the information is contained in tox.envlist and testenv.deps.
15
[tox]
26
requires =
37
tox>=4
@@ -16,6 +20,7 @@ envlist =
1620
typecheck
1721
skip_missing_interpreters = true
1822

23+
# Configuration that allows us to split tests across GitHub runners effectively
1924
[gh-actions]
2025
python =
2126
3.8: py38
@@ -35,14 +40,8 @@ ARCH =
3540
x64: x64
3641
x86: x86
3742

38-
CHECK =
39-
build: build
40-
doctest: doctest
41-
style: style
42-
typecheck: typecheck
43-
4443
[testenv]
45-
description = Typical pytest invocation with coverage
44+
description = Pytest with coverage
4645
labels = test
4746
install_command =
4847
python -I -m pip install \
@@ -96,7 +95,7 @@ commands =
9695
--pyargs nibabel {posargs:-n auto}
9796

9897
[testenv:install]
99-
description = "Install and verify imports succeed"
98+
description = Install and verify import succeeds
10099
labels = test
101100
deps =
102101
extras =
@@ -105,15 +104,15 @@ commands =
105104
python -c "import nibabel; print(nibabel.__version__)"
106105

107106
[testenv:docs]
108-
description = Typical pytest invocation with coverage
107+
description = Build documentation site
109108
labels = docs
110109
allowlist_externals = make
111110
extras = doc
112111
commands =
113112
make -C doc html
114113

115114
[testenv:doctest]
116-
description = Typical pytest invocation with coverage
115+
description = Run doctests in documentation site
117116
labels = docs
118117
allowlist_externals = make
119118
extras =

0 commit comments

Comments
 (0)