tox.ini

[tox]
min_version = 4.0
envlist =
    py{38,39,310,311}-test
    py38-test-oldestdeps
    build_docs
isolated_build = true

[testenv]
# 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
    oldestdeps: with the oldest supported version of key dependencies

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

# Suppress display of matplotlib plots generated during docs build
set_env = 
    MPLBACKEND=agg

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

deps =
    oldestdeps: minimum_dependencies
    pytest-cov

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

commands_pre =
    oldestdeps: minimum_dependencies packagename --filename requirements-min.txt
    oldestdeps: pip install -r requirements-min.txt
    pip freeze

commands =
    pytest --pyargs packagename --cov sdss_solara --cov-report xml:coverage.xml --cov-report term-missing {posargs}

[testenv:build_docs]
description = invoke sphinx-build to build the HTML docs
change_dir =
    docs
extras = 
    docs
commands =
    sphinx-build -j auto --color -W --keep-going -b html -d _build/.doctrees . _build/html {posargs}