tox.ini

# https://github.com/ComPWA/ampform/blob/2ad1f7d14dc9bb58045a0fa83af4a353232dc5a6/tox.ini
[tox]
envlist =
    py,
    doc,
    sty,
passenv = PYTHONPATH
skip_install = True
skip_missing_interpreters = True
skipsdist = True

[testenv]
description =
    Run all unit tests
allowlist_externals =
    pytest
commands =
    pytest {posargs}

[testenv:doc]
description =
    Build documentation and API through Sphinx
changedir = docs
allowlist_externals =
    make
commands =
    make html

[testenv:doclive]
description =
    Set up a server to directly preview changes to the HTML pages
allowlist_externals =
    sphinx-autobuild
passenv =
    EXECUTE_NB
    TERM
commands =
    sphinx-autobuild \
        --watch docs \
        --watch mpl_interactions \
        --re-ignore .*/.ipynb_checkpoints/.* \
        --re-ignore .*/__pycache__/.* \
        --re-ignore docs/_build/.* \
        --re-ignore docs/api/.* \
        --re-ignore docs/examples/.*.gif \
        --re-ignore docs/gallery/.* \
        --open-browser \
        docs/ docs/_build/html

[testenv:docnb]
description =
    Build documentation through Sphinx WITH output of Jupyter notebooks
setenv =
    EXECUTE_NB = "yes"
changedir = docs
allowlist_externals =
    make
commands =
    make html

[testenv:linkcheck]
description =
    Check external links in the documentation (requires internet connection)
changedir = docs
allowlist_externals =
    make
commands =
    make ignore-warnings=1 linkcheck # for margin directive

[testenv:sty]
description =
    Perform all linting, formatting, and spelling checks
allowlist_externals =
    pre-commit
commands =
    pre-commit run {posargs} -a