tox.ini

[tox]
description = Default environments to be executed when calling tox
envlist =
    code-style
    doc-style
    doc-{links,html}
isolated_build = true
isolated_build_env = build
skipsdist = true

[testenv]
description = Generic environment configuration
basepython =
    {code-style,doc-style,doc-links,doc-html}: python3
passenv = *
setenv =
    PYTHONUNBUFFERED = yes
skip_install = false

[testenv:style]
description = Checks if code style applies
skip_install = true
deps =
    pre-commit
commands =
    pre-commit install
    pre-commit run --all-files --show-diff-on-failure

[testenv:code-style]
description = Checks if code style applies
skip_install = true
deps =
    pre-commit
commands =
    pre-commit install
    pre-commit run --all-files --show-diff-on-failure

[testenv:doc-style]
description = Checks project documentation style
skip_install = true
allowlist_externals =
    vale
commands =
    vale sync --config="{toxinidir}/doc/.vale.ini"
    vale --config="{toxinidir}/doc/.vale.ini" "{toxinidir}/doc"

[testenv:doc-{links,html}]
description = Checks if project documentation properly builds
skip_install = false
setenv =
    links: BUILDER = linkcheck
    html: BUILDER = html
deps =
    -r{toxinidir}/requirements/requirements_doc.txt
allowlist_externals=*
commands =
    sphinx-build -d "{toxworkdir}/doc_doctree" doc/source "{toxinidir}/doc/_build/{env:BUILDER}" --color -vW -b {env:BUILDER}