tox.embedapi.ini

[tox]
# NOTE: Currently tox 3 is required, breaks with tox 4, possibly basepython 3.10 needs to be defined
requires =
  tox<4

# NOTE: Sphinx 3.5 and 4.x < 4.2 fails with Python 3.10 because of a typing issue
#
# NOTE: Sphinx 1.8 and 2.0 are not tested anymore because of some
# incompatibilities with Python 3.10 and sphinxcontrib-bibtex
envlist = sphinx-{24,35,45,53,62,72,latest,24-docutils-016,35-docutils-017}

[testenv]
description = run test suite for the EmbedAPIv3
allowlist_externals =
    sh
install_command =
    # Install requirements in multiple steps because we don't want to install
    # Sphinx from `requirements/pip.txt` but from the `deps=` field.
    sh -c ' \
        cat {toxinidir}/requirements/testing.txt | grep -v "Sphinx" > {toxinidir}/requirements/embedapi.txt; \
        pip install -r {toxinidir}/requirements/embedapi.txt; \
        pip install $*;' -- {opts} {packages}
deps =
    sphinx-24: Sphinx~=2.4.0
    sphinx-35: Sphinx~=3.5.0
    sphinx-45: Sphinx~=4.5.0
    sphinx-53: Sphinx~=5.3.0
    sphinx-62: Sphinx~=6.2.0
    sphinx-72: Sphinx~=7.2.0
    sphinx-latest: Sphinx
    # Keep at least one Sphinx version with docutils 0.16 and 0.17 since the
    # HTML generated changes a little between them
    sphinx-24-docutils-016: Sphinx~=2.4.0 docutils==0.16
    sphinx-35-docutils-017: Sphinx~=3.5.0 docutils==0.17
    sphinxcontrib-bibtex~=2.3.0
    jinja2<3.1.0
setenv =
    DJANGO_SETTINGS_MODULE=readthedocs.settings.test
    VIRTUALENV_SETUPTOOLS=58.3.0
changedir = {toxinidir}/readthedocs
commands = pytest -m embed_api --nomigrations {posargs}