tox.ini

[testenv:bootstrap]
deps =
    jinja2
    tox
skip_install = true
commands =
    python ci/bootstrap.py --no-env
passenv =
    *
; a generative tox configuration, see: https://tox.readthedocs.io/en/latest/config.html#generative-envlist

[tox]
# https://tox.readthedocs.io/en/latest/config.html
isolated_build = True
envlist =
    clean,
    docs,
    {py37,py38,py39,py310},
    report
ignore_basepython_conflict = true
requires =
    # Installing with "requires" even though it's not the recommended option
    # https://github.com/enpaul/tox-poetry-installer/#installing
    tox-poetry-installer[poetry] >= 0.9.0

[testenv]
basepython =
    py37: {env:TOXPYTHON:python3.7}
    py38: {env:TOXPYTHON:python3.8}
    py39: {env:TOXPYTHON:python3.9}
    {bootstrap,clean,report,docs,codecov}: {env:TOXPYTHON:python3}
    # To avoid InterpreterNotFound. See https://github.com/tox-dev/tox/issues/1548
    .package: python3
setenv =
    PYTHONPATH={toxinidir}/tests
    PYTHONUNBUFFERED=yes
passenv =
    *
usedevelop = false
; https://github.com/enpaul/tox-poetry-installer/#quick-start
poetry_dep_groups =
    dev
commands =
    {posargs:pytest --cov --cov-report=term-missing -vv tests}

[testenv:docs]
usedevelop = true
deps =
    -r{toxinidir}/docs/requirements.txt
commands =
    sphinx-build {posargs:-E} -b doctest docs dist/docs
    sphinx-build {posargs:-E} -b html docs dist/docs
    # TODO: ci: remove the dash after PyPI and ReadTheDocs are live
    # TODO: ditch Sphinx and use MkDocs instead? Hosting on GitHub itself
    -sphinx-build -b linkcheck docs dist/docs

[testenv:codecov]
deps =
    codecov
skip_install = true
commands =
    codecov []

[testenv:report]
deps =
    coverage
skip_install = true
commands =
    coverage report
    coverage html

[testenv:clean]
commands = coverage erase
skip_install = true
deps =
    coverage