Skip to content

Commit dcd0ccf

Browse files
committed
Add some comments to tox.ini
Mainly explaining the environment matrix
1 parent 7e96dfe commit dcd0ccf

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

tox.ini

+15-1
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,35 @@
22
minversion=2.0
33
isolated_build=True
44
envlist=
5+
# Test all Python versions on latest lib versions
56
py3{6,7,8,9,10,11}-sphx_latest-attrs_latest-jsch_latest
7+
# Test dev Python version on current in-repo dev lib versions
68
py310-sphx_dev-attrs_dev-jsch_dev
7-
py310-sphx_{1_6_x,1_x,2_x,3_x,4_x,dev}-attrs_latest-jsch_latest
9+
# Scan across Sphinx versions
10+
py310-sphx_{1_6_x,1_x,2_x,4_x,dev}-attrs_latest-jsch_latest
11+
# sphx_3_x is incompatible with py310 due to a typing import. Test on py39 instead.
12+
py39-sphx_3_x-attrs_latest-jsch_latest
13+
# Scan attrs versions
814
py310-sphx_latest-attrs_{19_2,19_3,20_1,20_2,20_3,21_2,21_3,dev}-jsch_latest
15+
# Scan jsonschema versions
916
py310-sphx_latest-attrs_latest-jsch_{3_0,3_1,3_2,4_0,4_1,dev}
17+
# Earliest supported Python and lib versions all together
1018
py36-sphx_1_6_x-attrs_19_2-jsch_3_0
19+
# Spot matrix of early Python, Sphinx, attrs versions
1120
py3{7,8,9}-sphx_{1,2}_x-attrs_{19,20}_2-jsch_latest
21+
# Test the specific Sphinx threshold cases where behavior changed
1222
py310-sphx_{2_3_1,2_4_0,3_2_1,3_3_0,3_4_0}-attrs_latest-jsch_latest
23+
# Simple 'does the sdist install' check
1324
sdist_install
25+
# Lints
1426
flake8
1527

1628
[testenv]
1729
commands=
1830
python --version
1931
pip list
32+
# Want the tox *matrix* to ignore warnings since it's primarily
33+
# a compatibility check. The defaults for bare pytest enable -Werror
2034
pytest {posargs:--nonloc -Wignore}
2135
deps=
2236
sphx_1_6_x: sphinx<1.7

0 commit comments

Comments
 (0)