mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
13b16c9b04
`todo` admonitions should not be present in the user-facing documentation (built on ReadTheDocs)
77 lines
1.4 KiB
INI
77 lines
1.4 KiB
INI
[tox]
|
|
minversion = 2.4.0
|
|
envlist = py{39,310,311,312,313}
|
|
isolated_build = True
|
|
|
|
[testenv]
|
|
usedevelop = True
|
|
passenv =
|
|
https_proxy
|
|
http_proxy
|
|
no_proxy
|
|
COLORTERM
|
|
PERL
|
|
PERL5LIB
|
|
PYTEST_ADDOPTS
|
|
DO_EPUBCHECK
|
|
EPUBCHECK_PATH
|
|
TERM
|
|
CLEAN
|
|
BUILDER
|
|
READTHEDOCS
|
|
description =
|
|
py{39,310,311,312,313}: Run unit tests against {envname}.
|
|
extras =
|
|
test
|
|
setenv =
|
|
PYTHONWARNINGS = error
|
|
PYTEST_ADDOPTS = {env:PYTEST_ADDOPTS:} --color yes
|
|
commands=
|
|
python -X dev -X warn_default_encoding -m pytest --durations 25 {posargs}
|
|
|
|
[testenv:docs]
|
|
basepython = python3
|
|
description =
|
|
Build documentation.
|
|
extras =
|
|
docs
|
|
commands =
|
|
python -c "import shutil; shutil.rmtree('./build/sphinx', ignore_errors=True) if '{env:CLEAN:}' else None"
|
|
sphinx-build -M {env:BUILDER:html} ./doc ./build/sphinx -nW --keep-going {posargs}
|
|
|
|
[testenv:docs-live]
|
|
basepython = python3
|
|
description =
|
|
Build documentation.
|
|
extras =
|
|
docs
|
|
deps =
|
|
sphinx-autobuild
|
|
commands =
|
|
sphinx-autobuild ./doc ./build/sphinx/
|
|
|
|
[testenv:bindep]
|
|
description =
|
|
Install binary dependencies.
|
|
deps =
|
|
bindep
|
|
commands =
|
|
bindep test
|
|
|
|
[testenv:ruff]
|
|
description =
|
|
Run ruff formatting and linting.
|
|
extras =
|
|
lint
|
|
commands =
|
|
ruff format .
|
|
ruff check --fix .
|
|
|
|
[testenv:mypy]
|
|
description =
|
|
Run mypy type checking.
|
|
extras =
|
|
lint
|
|
test
|
|
commands = mypy {posargs}
|