[tox]
minversion = 1.6.0
envlist =
    coala,
    docs,
    docs-linkcheck,
    pep8
skipsdist = true

[testenv:docs]
allowlist_externals = echo
deps = -rdocs/requirements.txt
commands =
    sphinx-build -W -b html -n -W -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
    echo "Generated docs available in {toxinidir}/docs/_build/html"

[testenv:docs-linkcheck]
deps = -rdocs/requirements.txt
commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck

[testenv:pep8]
deps =
    flake8
commands = flake8

[flake8]
show-source = True
max-line-length = 120
# - Select E121, E123, E126, E226, E241, E242 and E704 which are turned OFF
#   by default but represent guidelines accepted by us.
# - Do not select E133 because it is incompatible with E123 which was
#   selected instead.
# - It turns out that now all checks except E133 are enabled so the select
#   can be simplified to be just "E,W". However a new version could change
#   that (select E133 instead of E123) but that should be caught by the
#   verify job.
select = E,W
exclude =
    .git,
    .tox,
    docs/conf.py