tox.ini

[tox]
minversion = 2.4
envlist = python

[testenv]
commands =
    {envpython} -m \
      pytest \
      {tty:--color=yes} \
      {posargs:}
    python setup.py checkdocs
usedevelop = True
extras = testing
passenv =
  WEBTEST_INTERACTIVE
  CI
  TRAVIS
  TRAVIS_*
  APPVEYOR
  APPVEYOR_*
  PYTEST_*

[testenv:build-docs]
basepython = python3.8
description = Build The Docs
changedir = docs
commands =
    # Build docs site:
    python -m sphinx \
      -j auto \
      -a -n -W \
      -b html --color \
      -d "{toxworkdir}/docs_doctree" \
      . "{toxworkdir}/docs_out"

    # Print out the output docs dir and a way to serve html:
    python -c\
    'import pathlib;\
    docs_dir = pathlib.Path(r"{toxworkdir}") / "docs_out";\
    index_file = docs_dir / "index.html";\
    print(f"\nDocumentation available under\
    `file://\{index_file\}`\n\nTo serve docs, use\
    `python3 -m http.server --directory \
    \N\{QUOTATION MARK\}\{docs_dir\}\N\{QUOTATION MARK\} 0`\n")'
extras =
    docs
    testing

[testenv:pre-commit]
deps = pre-commit
commands = pre-commit run --all-files {posargs}

[testenv:pre-commit-pep257]
deps = pre-commit
commands =
  sed -i.bak 's/^\s\+exclude: magicbus\/test$//g' .pre-commit-config.yaml
  pre-commit run --all-files pep257 {posargs}