tox.ini

[tox]
min_version = 4.0
envlist =
    py{310,311,312,313}-test
    ; py10-test-oldestdeps
    build_docs
    codestyle

[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 =
    # A variable to tell tests we are on a CI system
    CI
    # Custom compiler locations (such as ccache)
    CC
    # Location of locales (needed by sphinx on some systems)
    LOCALE_ARCHIVE
    # If the user has set a LC override we should follow it
    # (note LANG is automatically passed through by tox)
    LC_ALL

# 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 solarmach --filename requirements-min.txt
    ; oldestdeps: pip install -r requirements-min.txt
    pip freeze

commands =
    pytest --pyargs solarmach --cov solarmach --cov-report xml:coverage.xml --cov-report term-missing {posargs} --mpl
    # pytest --pyargs solarmach {toxinidir}/docs --cov solarmach --cov-config={toxinidir}/setup.cfg {posargs} --mpl

[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}

[flake8]
select = E101,E11,E111,E112,E113,E121,E122,E123,E124,E125,E126,E127,E128,E129,E131,E133,E20,E211,E231,E241,E242,E251,E252,E26,E265,E266,E27,E301,E302,E303,E304,E305,E306,E401,E402,E502,E701,E711,E712,E713,E714,E722,E731,E901,E902,F822,F823,W191,W291,W292,W293,W391,W601,W602,W603,W604,W605,W690