tox.ini

[tox]
minversion = 2.0
envlist = lint,docs

[testenv]
usedevelop = False
install_command = pip install {opts} {packages}
deps =
    -r{toxinidir}/test-requirements.txt
    -r{toxinidir}/requirements.txt
sitepackages = False
whitelist_externals =
  rm
  make

[testenv:lint]
commands =
  doc8 doc

[doc8]
# Settings for doc8:
# Ignore target directories and autogenerated files
ignore-path = doc/*/target,doc/*/build*
# File extensions to use
extensions = .rst,.txt
# Maximal line length should be 79 but we have some overlong lines.
# Let's not get far more in.
max-line-length = 79
# Disable some doc8 checks:
# D000: Check RST validity (cannot handle the "linenos" directive)
# D001: Line too long
# D002: Trailing Whitespace (not compatible with DOS/Windows files)
# D004: Found literal carriage return (not compatible with DOS/Windows files)
ignore = D000,D001,D002,D004

[testenv:venv]
commands = {posargs}

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

[testenv:html]
commands =
  sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html

[flake8]
exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,tools
show-source = True
enable-extensions = H203,H106