tox.ini

[flake8]
max-line-length = 99
extend-ignore = E203
extend-exclude = node_modules, venv

# tox-gh-actions configuration.
[gh-actions]
python =
    3.12: lint, fmt-check, type-check, user-guide

[tox]
envlist =
    fmt-check
    lint
    type-check
    user-guide
skipsdist = true

[testenv:type-check]
deps =
    -r{toxinidir}/dev-requirements.txt
commands =
    mypy deploy scripts
    mypy --platform linux maintenance/scripts

[testenv:lint]
deps =
    -r{toxinidir}/dev-requirements.txt
commands =
    flake8

[testenv:fmt]
deps =
    -r{toxinidir}/dev-requirements.txt
commands =
    isort .
    black .

[testenv:fmt-check]
deps =
    -r{toxinidir}/dev-requirements.txt
commands =
    isort --check .
    black --check .

[testenv:user-guide]
deps =
    -r{toxinidir}/dev-requirements.txt
changedir = {toxinidir}/docs/user_guide/
commands =
    mkdocs build

[testenv:user-guide-serve]
deps =
    -r{toxinidir}/dev-requirements.txt
changedir = {toxinidir}/docs/user_guide/
commands =
    mkdocs serve

[testenv:user-guide-github-pages]
deps =
    -r{toxinidir}/dev-requirements.txt
changedir = {toxinidir}/docs/user_guide/
commands =
    # See: https://squidfunk.github.io/mkdocs-material/publishing-your-site/
    mkdocs gh-deploy --force