tox.ini

[tox]
minversion = 3.2.0
envlist=py,linter,docs

[testenv]
extras =
    test
commands=
    python -m pytest \
      --cov=sphinxcontrib.spelling \
      --cov-report term-missing \
      --log-level DEBUG
passenv=
    # Let the caller point to where libenchant is on their system, in
    # case it's in an unusual place. For example, on macOS with
    # Homebrew installing python 3.9 by default but tox being run from
    # the python.org distribution of 3.10, set
    # PYENCHANT_LIBRARY_PATH=/opt/homebrew/lib/libenchant-2.dylib in
    # the shell environment before running tox.
    PYENCHANT_LIBRARY_PATH

[testenv:isolated]
isolated_build=true
changedir={envtmpdir}
allowlist_externals =
    /bin/cp
    /bin/rm
commands=
    /bin/rm -rf tests
    /bin/cp -a {toxinidir}/tests .
    python -m pytest \
      --cov=sphinxcontrib.spelling \
      --cov-report term-missing \
      --log-level DEBUG

[testenv:linter]
deps = -r requirements-dev.txt
setenv =
    BUILD=linter
commands =
    ruff check sphinxcontrib integration_tests tests
skip_install = true

[testenv:pkglint]
deps=
    build
    twine
    check-python-versions
commands=
    python -m build
    twine check dist/*.tar.gz dist/*.whl
    check-python-versions --only pyproject.toml,.github/workflows/test.yml

[flake8]
show-source = True
exclude = .tox,dist,doc,*.egg,build
ignore = W504
per-file-ignores =
    integration_tests/build_django.py: DB100

[testenv:docs]
setenv =
    BUILD=docs
    ENABLE_SPELLING=1
commands =
    sphinx-build -W -j auto -b html -d docs/build/doctrees docs/source docs/build/html
    sphinx-build -W -j auto -b linkcheck -d docs/build/doctrees docs/source docs/build/linkcheck
    sphinx-build -W -j auto -b spelling -d docs/build/doctrees docs/source docs/build/spelling

[testenv:spelling]
setenv =
    BUILD=docs
    ENABLE_SPELLING=1
commands =
    sphinx-build -W -j auto -b spelling -d docs/build/doctrees docs/source docs/build/spelling