Red-DiscordBot/tox.ini
Michael H d4b6fdea92 Add towncrier (#2873)
* Adds towncrier as our changelog system.
* Updates our contributor guidelines for this.

Resolves #2872
2019-07-17 11:12:43 +10:00

53 lines
1.5 KiB
INI

# tox (https://tox.readthedocs.io/) is a tool for running tests
# in multiple virtualenvs. This configuration file will run the
# test suite on all supported python versions. To use it, "pip install tox"
# and then run "tox" from this directory.
[tox]
envlist =
py37
docs
style
skip_missing_interpreters = True
[testenv]
description = Run tests and basic automatic issue checking.
whitelist_externals =
pytest
pylint
extras = voice, test, mongo
commands =
python -m compileall ./redbot/cogs
pytest
pylint ./redbot
[testenv:docs]
description = Attempt to build docs with sphinx-build
whitelist_externals =
sphinx-build
make
setenv =
# This is just for Windows
# Prioritise make.bat over any make.exe which might be on PATH
PATHEXT=.BAT;.EXE
basepython = python3.7
extras = docs, mongo
commands =
sphinx-build -d "{toxworkdir}/docs_doctree" docs "{toxworkdir}/docs_out/html" -W -bhtml
sphinx-build -d "{toxworkdir}/docs_doctree" docs "{toxworkdir}/docs_out/linkcheck" -W -blinkcheck
sphinx-build -d "{toxworkdir}/docs_doctree" docs "{toxworkdir}/docs_out/doctest" -W -bdoctest
make checkchangelog
[testenv:style]
description = Stylecheck the code with black to see if anything needs changes.
whitelist_externals =
make
setenv =
# This is just for Windows
# Prioritise make.bat over any make.exe which might be on PATH
PATHEXT=.BAT;.EXE
basepython = python3.7
extras = style
commands =
make stylecheck