quantecon-book-theme/tox.ini at main · QuantEcon/quantecon-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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
# 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 = py{312,313}-sphinx7

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

[testenv:py{312,313}-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
whitelist_externals = rm
commands =
    clean: rm -rf docs/_build
    sphinx-build -n --keep-going -b {posargs:html} docs/ docs/_build/{posargs:html}

[testenv:docs-live]
extras =
    doc
deps =
    sphinx-theme-builder[cli]
commands =
    stb serve docs --open-browser

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

[testenv:visual]
description = Run visual regression tests with Playwright
passenv =
    TERM
    HOME
    CI
    PATH
setenv =
    SNAPSHOT_DIR = macos
deps =
    jupyter-book==1.0.4post1
    sphinx-exercise
    sphinx-proof
    sphinxcontrib-youtube
    sphinx-togglebutton
    sphinxext-rediraffe
    sphinx-reredirects
allowlist_externals =
    npm
    npx
    git
    bash
commands =
    # Clone the test lecture site if not present
    bash -c "[ -d lecture-python-programming ] || git clone --branch quantecon-book-theme https://github.com/QuantEcon/lecture-python-programming"
    # Build the lecture site if not already built
    bash -c "[ -d lecture-python-programming/lectures/_build/html ] || (cd lecture-python-programming && jb build lectures)"
    # Install npm dependencies including Playwright
    npm ci
    npx playwright install chromium
    # Run visual tests
    npm run test:visual {posargs}

[testenv:visual-update]
description = Update visual regression test baselines
passenv =
    TERM
    HOME
    PATH
setenv =
    SNAPSHOT_DIR = macos
deps =
    jupyter-book==1.0.4post1
    sphinx-exercise
    sphinx-proof
    sphinxcontrib-youtube
    sphinx-togglebutton
    sphinxext-rediraffe
    sphinx-reredirects
allowlist_externals =
    npm
    npx
    git
    bash
commands =
    bash -c "[ -d lecture-python-programming ] || git clone --branch quantecon-book-theme https://github.com/QuantEcon/lecture-python-programming"
    bash -c "[ -d lecture-python-programming/lectures/_build/html ] || (cd lecture-python-programming && jb build lectures)"
    npm ci
    npx playwright install chromium
    npm run test:visual:update {posargs}