Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add description for tox tasks #3868

Merged
merged 1 commit into from Mar 28, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions tox.ini
@@ -1,4 +1,5 @@
[tox]
minversion=2.9.0
envlist = py{27,36},lint,docs
skipsdist = True

Expand All @@ -8,6 +9,7 @@ python =
3.6: py36

[testenv]
description = run test suite for the application with {basepython}
setenv =
PYTHONPATH={toxinidir}/readthedocs:{toxinidir}
DJANGO_SETTINGS_MODULE=readthedocs.settings.test
Expand All @@ -19,11 +21,13 @@ commands =
py.test {posargs}

[testenv:docs]
description = build readthedocs documentation
changedir = {toxinidir}/docs
commands =
sphinx-build -b html -d {envtmpdir}/doctrees . {envtmpdir}/html

[testenv:lint]
description = run linter (prospector) to ensure the source code corresponds to our coding standards
deps = -r{toxinidir}/requirements/lint.txt
commands =
prospector \
Expand All @@ -36,10 +40,12 @@ commands =
--die-on-tool-error {posargs}

[testenv:eslint]
description = run the JavaScript linter (requires gulp installed)
commands =
gulp lint

[testenv:coverage]
description = run test suite with code coverage for the application with {basepython}
deps =
-r{toxinidir}/requirements/testing.txt
pytest-cov
Expand Down