Merge pull request #12510 from pytest-dev/patchback/backports/8.2.x/b864e50138a34ebaf188829f2a4fcdf4d9e0a541/pr-12498

This commit is contained in:
Sviatoslav Sydorenko (Святослав Сидоренко) 2024-06-21 17:23:03 +02:00 committed by GitHub
commit 7a0cb6b37d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 32 additions and 0 deletions

View File

@ -0,0 +1,5 @@
All the undocumented ``tox`` environments now have descriptions.
They can be listed in one's development environment by invoking
``tox -av`` in a terminal.
-- by :user:`webknjaz`

27
tox.ini
View File

@ -26,6 +26,20 @@ envlist =
[testenv]
description =
run the tests
coverage: collecting coverage
exceptiongroup: against `exceptiongroup`
nobyte: in no-bytecode mode
lsof: with `--lsof` pytest CLI option
numpy: against `numpy`
pexpect: against `pexpect`
pluggymain: against the bleeding edge `pluggy` from Git
pylib: against `py` lib
unittestextras: against the unit test extras
xdist: with pytest in parallel mode
under `{basepython}`
doctesting: including doctests
commands =
{env:_PYTEST_TOX_COVERAGE_RUN:} pytest {posargs:{env:_PYTEST_TOX_DEFAULT_POSARGS:}}
doctesting: {env:_PYTEST_TOX_COVERAGE_RUN:} pytest --doctest-modules --pyargs _pytest
@ -72,6 +86,8 @@ deps =
{env:_PYTEST_TOX_EXTRA_DEP:}
[testenv:linting]
description =
run pre-commit-defined linters under `{basepython}`
skip_install = True
basepython = python3
deps = pre-commit>=2.9.3
@ -81,6 +97,9 @@ setenv =
PYTHONWARNDEFAULTENCODING=
[testenv:docs]
description =
build the documentation site under \
`{toxinidir}{/}doc{/}en{/}_build{/}html` with `{basepython}`
basepython = python3.12 # sync with rtd to get errors
usedevelop = True
deps =
@ -102,6 +121,8 @@ setenv =
PYTHONWARNDEFAULTENCODING=
[testenv:docs-checklinks]
description =
check the links in the documentation with `{basepython}`
basepython = python3
usedevelop = True
changedir = doc/en
@ -113,6 +134,8 @@ setenv =
PYTHONWARNDEFAULTENCODING=
[testenv:regen]
description =
regenerate documentation examples under `{basepython}`
changedir = doc/en
basepython = python3
passenv =
@ -130,6 +153,8 @@ setenv =
PYTHONWARNDEFAULTENCODING=
[testenv:plugins]
description =
run reverse dependency testing against pytest plugins under `{basepython}`
# use latest versions of all plugins, including pre-releases
pip_pre=true
# use latest pip to get new dependency resolver (#7783)
@ -156,6 +181,8 @@ commands =
pytest simple_integration.py --force-sugar --flakes
[testenv:py38-freeze]
description =
test pytest frozen with `pyinstaller` under `{basepython}`
changedir = testing/freeze
deps =
pyinstaller