Add tox environment to build HTML documentation · EliahKagan/GitPython@e6ec6c8 (original) (raw)

Original file line number Diff line number Diff line change
@@ -11,16 +11,25 @@ commands = pytest --color=yes {posargs}
11 11
12 12 [testenv:lint]
13 13 description = Lint via pre-commit
14 -basepython = py39
14 +base_python = py39
15 15 commands = pre-commit run --all-files
16 16
17 17 [testenv:mypy]
18 18 description = Typecheck with mypy
19 -basepython = py39
19 +base_python = py39
20 20 commands = mypy -p git
21 21 ignore_outcome = true
22 22
23 23 [testenv:black]
24 24 description = Check style with black
25 -basepython = py39
25 +base_python = py39
26 26 commands = black --check --diff git
27 +
28 +# Run "tox -e html" for this. It is deliberately excluded from env_list, as
29 +# unlike the other environments, this one writes outside the .tox/ directory.
30 +[testenv:html]
31 +description = Build HTML documentation
32 +base_python = py39
33 +deps = -r doc/requirements.txt
34 +allowlist_externals = make
35 +commands = make -C doc html