tox.ini

[tox]
envlist =
    py{39,311}-test{,-alldeps}{,-cov}
    py{39,311}-test-astropy{40,lts}
    build_docs
    linkcheck
    codestyle
requires =
    setuptools
    pip
isolated_build = true

[testenv]
# Suppress display of matplotlib plots generated during docs build
setenv =
    MPLBACKEND=Agg
    CFLAGS=-O0 -ggdb

# Pass through the following environment variables which may be needed for the CI
passenv = HOME, WINDIR, LC_ALL, LC_CTYPE, CC, CI, TRAVIS

# Run the tests in a temporary directory to make sure that we don't import
# this package from the source tree
changedir = .tmp/{envname}

# tox environments are constructed with so-called 'factors' (or terms)
# separated by hyphens, e.g. test-devdeps-cov. Lines below starting with factor:
# will only take effect if that factor is included in the environment name. To
# see a list of example environments that can be run, along with a description,
# run:
#
#     tox -l -v
#
description =
    run tests
    alldeps: with all optional dependencies
    oldestdeps: with the oldest supported version of key dependencies
    cov: and test coverage
    astropy40: with astropy 4.0.*
    astropylts: with the latest astropy LTS

# The following provides some specific pinnings for key packages
deps =

    astropy40: astropy==4.0.*
    astropylts: astropy==5.*

    numpy>=1.24
    scipy
    matplotlib
    jaxlib
    jax
    arviz
    Cython

# Configure deps installed via conda
# conda_deps=
#    llvm
#    clang-11

# conda_channels=
#    conda-forge

# The following indicates which extras_require from setup.cfg will be installed
extras =
    test

commands =
    pip freeze
    !cov: pytest --pyargs kelp {toxinidir}/docs {posargs}
    cov: pytest --pyargs kelp {toxinidir}/docs --cov kelp --cov-config={toxinidir}/setup.cfg {posargs}

[testenv:build_docs]
changedir = docs
description = invoke sphinx-build to build the HTML docs
extras =
    docs
commands =
    pip freeze
    sphinx-build -b html . _build/html

[testenv:linkcheck]
changedir = docs
description = check the links in the HTML docs
extras =
    docs
commands =
    pip freeze
    sphinx-build -W -b linkcheck . _build/html

[testenv:codestyle]
skip_install = true
changedir = .
description = check code style, e.g. with flake8
deps = flake8
commands = flake8 kelp --count --max-line-length=100 --ignore=E741,E226,W504,W504,E743,E128,E124,E201