sphinx-book-theme/tox.ini at main · executablebooks/sphinx-book-theme · 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
68
69
# To use tox, see https://tox.readthedocs.io
# Simply pip or conda install tox
# If you use conda, you may also want to install tox-conda
# then run `tox` or `tox -- {pytest args}`
# To run in parallel using `tox -p` (this does not appear to work for this repo)

# To rebuild the tox environment, for example when dependencies change, use
# `tox -r`

# Note: if the following error is encountered: `ImportError while loading conftest`
# then then deleting compiled files has been found to fix it: `find . -name \*.pyc -delete`

[tox]
envlist = py313-sphinx8

[testenv]
usedevelop=true
passenv = TERM  # To make terminal coloring / other variables pass through

[testenv:py{311,312,313,314}-pre-commit]
extras = code_style
commands = pre-commit run {posargs}

[testenv:compile]
deps =
    sphinx-theme-builder[cli]
commands =
    stb compile

[testenv:docs-{update,clean}]
extras =
    doc
deps =
    sphinx-theme-builder[cli]
whitelist_externals = rm
commands =
    clean: rm -rf docs/_build
    sphinx-build -n --keep-going -b {posargs:html} docs/ docs/_build/{posargs:html}

[testenv:docs-linkcheck]
extras =
    doc
deps =
    sphinx-theme-builder[cli]
commands =
    sphinx-build -b linkcheck docs docs/_build/linkcheck

[testenv:docs-live]
usedevelop = true
extras =
    doc
deps =
    sphinx-theme-builder[cli]
    sphinx-autobuild
commands =
    sphinx-autobuild docs docs/_build/html --open-browser \
        --watch src/sphinx_book_theme/assets \
        --watch src/sphinx_book_theme/theme \
        --ignore "docs/_build/*" \
        --re-ignore ".*\.pyc" \
        --re-ignore ".*~"

[testenv:py{311,312,313,314}-sphinx{7,8,9}]
extras = test
deps =
    sphinx7: sphinx>=7,<8
    sphinx8: sphinx>=8,<9
    sphinx9: sphinx>=9,<10
commands = pytest {posargs}