Skip to content

Commit

Permalink
Add tox environment to build HTML documentation
Browse files Browse the repository at this point in the history
The main use of this, similar to the step at the end of
pythonpackage.yml, is to find errors produced by building.

However, actual documentation *is* built, and unlike other tox
environments, running this one actually writes outside the .tox/
directory, creating the documentation in the usual target
location. For that reason, this environment is omitted from the
env_list, so that it does not run by default and unexpectedly
overwrite documentation that may recently have been built before
changes are made that could cause generated documentation to be
different.
  • Loading branch information
EliahKagan committed Sep 19, 2023
1 parent 4bea7cf commit e6ec6c8
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,25 @@ commands = pytest --color=yes {posargs}

[testenv:lint]
description = Lint via pre-commit
basepython = py39
base_python = py39
commands = pre-commit run --all-files

[testenv:mypy]
description = Typecheck with mypy
basepython = py39
base_python = py39
commands = mypy -p git
ignore_outcome = true

[testenv:black]
description = Check style with black
basepython = py39
base_python = py39
commands = black --check --diff git

# Run "tox -e html" for this. It is deliberately excluded from env_list, as
# unlike the other environments, this one writes outside the .tox/ directory.
[testenv:html]
description = Build HTML documentation
base_python = py39
deps = -r doc/requirements.txt
allowlist_externals = make
commands = make -C doc html

0 comments on commit e6ec6c8

Please sign in to comment.