python-billiards/tox.ini at master · markus-ebke/python-billiards · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# tox (https://tox.readthedocs.io/) is a tool for running tests
# in multiple virtualenvs. This configuration file will run the
# test suite on all supported python versions. To use it, "pip install tox"
# and then run "tox" from this directory.

[tox]
envlist = py3{8,9,10,11,12,13}, metadata, docs-build, docs-lint
isolated_build = True

[testenv]
deps =
    pytest
    pytest-cov
extras =
    visualize
setenv =
    PYGLET_HEADLESS = True  # to prevent NoSuchDisplayException
commands =
    pytest

# Check package metadata
[testenv:metadata]
deps =
    build
    check-manifest
    twine>=1.11.0  # the README is in markdown
commands =
    check-manifest -v {toxinidir}
    python -m build
    python -m twine check --strict {toxinidir}/dist/*

# Build documentation
[testenv:docs-build]
deps =
    -r{toxinidir}/docs/requirements_docs.txt
commands =
    sphinx-build -E -W -b html {toxinidir}/docs {toxinidir}/build/docs

# Check docstrings and documentation files
[testenv:docs-lint]
deps =
    pydocstyle
    doc8
    -r{toxinidir}/docs/requirements_docs.txt
    numpy>=2.0.0  # for doctest we need the new representation of numpy scalars
commands =
    pydocstyle {toxinidir}/src/billiards
    doc8 {toxinidir}/docs/
    sphinx-build -E -W -b doctest {toxinidir}/docs {toxinidir}/build/docs
    sphinx-build -W -b linkcheck {toxinidir}/docs {toxinidir}/build/docs


# Configuration
[check-manifest]
ignore =
    docs/*
    docs/*/*
    CONTRIBUTING.md
    Notes.md
    Pipfile
    Pipfile.lock
    requirements_dev.txt
    tox.ini
    .bumpversion.cfg
    .flake8
    .pre-commit-config.yaml