-
Notifications
You must be signed in to change notification settings - Fork 0
/
tox.ini
80 lines (71 loc) · 2.42 KB
/
tox.ini
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
[tox]
envlist =
py{38,39,310}-test{,-image,-alldeps,-oldestdeps,-devdeps}{,-cov}{,-clocale}
build_docs
linkcheck
codestyle
requires =
setuptools >= 30.3.0
pip >= 19.3.1
isolated_build = true
[testenv]
# Suppress display of matplotlib plots generated during docs build
setenv =
clocale: LC_ALL = C
image: MPLBACKEND = agg
# Pass through the following environment variables which may be needed for the CI
passenv = HOME, WINDIR, LC_ALL, LC_CTYPE, CC, CI, IS_CRON, ARCH_ON_CI
# Run the tests in a temporary directory to make sure that we don't import
# this package from the source tree
changedir = tests
# tox environments are constructed with so-called 'factors' (or terms)
# separated by hyphens, e.g. test-devdeps-cov. Lines below starting with factor:
# will only take effect if that factor is included in the environment name. To
# see a list of example environments that can be run, along with a description,
# run:
#
# tox -l -v
#
description =
run tests
alldeps: with all optional dependencies
devdeps: with the latest developer version of key dependencies
oldestdeps: with the oldest supported version of key dependencies
cov: and test coverage
image: with image tests
# The following indicates which extras_require from pyproject.toml will be installed
extras =
test: test
alldeps: all
alldeps: test_all
commands =
pip freeze
!cov: pytest --pyargs {toxinidir}/tests {toxinidir}/src {toxinidir}/docs {posargs}
cov: pytest --pyargs {toxinidir}/tests {toxinidir}/src {toxinidir}/docs --cov bound_class.core --cov-config={toxinidir}/pyproject.toml {posargs}
cov: coverage xml -o {toxinidir}/coverage.xml
# This lets developers to use tox to build docs and ignores warnings.
# This is not used in CI; For that, we have RTD PR builder.
[testenv:build_docs]
changedir = {toxinidir}/../docs
description = invoke sphinx-build to build the HTML docs
extras =
docs
test
commands =
pip freeze
sphinx-build -b html . _build/html {posargs:-j auto}
[testenv:linkcheck]
changedir = docs
description = check the links in the HTML docs
extras = docs
commands =
pip freeze
sphinx-build -b linkcheck . _build/html {posargs:-W}
[testenv:codestyle]
skip_install = true
description = Run all style and file checks with pre-commit
deps =
pre-commit
commands =
pre-commit install-hooks
pre-commit run {posargs:--color always --all-files --show-diff-on-failure}