[tox]
minversion = 4.6.0
envlist = pep8

[testenv]
usedevelop = true
deps =
  -c{env:TOX_CONSTRAINTS_FILE:https://opendev.org/openstack/requirements/raw/upper-constraints.txt}
  -r{toxinidir}/requirements.txt
  -r{toxinidir}/doc/requirements.txt
sitepackages = False
allowlist_externals =
  rm
  make

[testenv:pep8]
description =
  Run style checks.
skip_install = true
deps =
  pre-commit
commands =
  pre-commit run -a

[testenv:venv]
commands = {posargs}

[testenv:docs]
commands =
  rm -rf doc/build/html doc/build/doctrees
  sphinx-build -a -E -W -j auto -d doc/build/doctrees -b html doc/source doc/build/html

[testenv:docs-starlingxdocs]
envdir = {toxworkdir}/docs
commands =
  rm -rf doc/build/html doc/build/doctrees
  sphinx-build -a -E -W -j auto -d doc/build/doctrees -b html -D html_theme=starlingxdocs doc/source doc/build/html

[testenv:html]
commands =
  rm -rf doc/build/html doc/build/doctrees api-ref/build
  sphinx-build -a -E -W -j auto -d doc/build/doctrees -b html doc/source doc/build/html
  sphinx-build -a -E -W -j auto -d api-ref/build/doctrees -b html api-ref/source api-ref/build/html

[testenv:releasenotes]
commands =
  rm -rf releasenotes/build
  sphinx-build -a -E -W -j auto -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html

[testenv:releasenotes-starlingxdocs]
commands =
  rm -rf releasenotes/build
  sphinx-build -a -E -W -j auto -d releasenotes/build/doctrees -b html -D html_theme=starlingxdocs releasenotes/source releasenotes/build/html

[testenv:api-ref]
commands =
  rm -rf api-ref/build
  sphinx-build -a -E -W -j auto -d api-ref/build/doctrees -b html api-ref/source api-ref/build/html

[testenv:api-ref-starlingxdocs]
commands =
  rm -rf api-ref/build
  sphinx-build -a -E -W -j auto -d api-ref/build/doctrees -b html -D html_theme=starlingxdocs api-ref/source api-ref/build/html

[testenv:pdf-docs]
envdir = {toxworkdir}/docs
commands =
  rm -rf doc/build/pdf
  sphinx-build -a -E -W -j auto -b latex doc/source doc/build/pdf
  make -C doc/build/pdf

[testenv:pdf-docs-starlingxdocs]
envdir = {toxworkdir}/docs
commands =
  rm -rf doc/build/pdf
  sphinx-build -a -E -W -j auto -b latex -D html_theme=starlingxdocs doc/source doc/build/pdf
  make -C doc/build/pdf

[testenv:bindep]
# Do not install any requirements. We want this to be fast and work even if
# system dependencies are missing, since it's used to tell you what system
# dependencies are missing! This also means that bindep must be installed
# separately, outside of the requirements files.
deps = bindep
commands = bindep test

[flake8]
exclude=.venv,.git,.tox,dist,doc,api-ref,*lib/python*,*egg,tools
show-source = True
# We only enable the hacking (H) checks
select = H
# H304 We're okay with relative imports
ignore = H304