tox.ini

[tox]
description = Default tox environments list
envlist =
    code-style
    doc-style
    doc-{links,html}
skip_missing_interpreters = true
isolated_build = true
isolated_build_env = build

[testenv]
description = Checks for project unit tests and coverage (if desired)
basepython =
    {code-style,doc-style,doc-links,doc-html}: python3
setenv =
    PYTHONUNBUFFERED = yes
    DOCUMENTATION_CNAME = sphinxdocs.ansys.com
passenv = *

[testenv:code-style]
description = check project code style
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 documentation links and pages generates properly
extras = doc
setenv =
    links: BUILDER = linkcheck
    html: BUILDER = html
commands =
    sphinx-build -d "{toxworkdir}/doc_doctree" doc/source "{toxinidir}/doc/_build/{env:BUILDER}" --color -v -b {env:BUILDER} -j auto -W --keep-going