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

add description for tox tasks #3868

merged 1 commit into from Mar 28, 2018

Conversation

@gaborbernat
Copy link
Contributor

@gaborbernat gaborbernat commented Mar 28, 2018

For example:

tox -av 
default environments:
py27     -> run test suite for the application with python2.7
py36     -> run test suite for the application with python3.6
lint     -> run linter (prospector) to ensure the source code corresponds to our coding standards
docs     -> build readthedocs documentation

additional environments:
coverage -> run test suite with code coverage for the application with /usr/bin/python
eslint   -> run the JavaScript linter (requires gulp installed)
For example:
default environments:
py27     -> run test suite for the application with python2.7
py36     -> run test suite for the application with python3.6
lint     -> run linter (prospector) to ensure the source code
corresponds to our coding standards
docs     -> build readthedocs documentation

additional environments:
coverage -> run test suite with code coverage for the application with
/usr/bin/python
eslint   -> run the JavaScript linter (requires gulp installed)
@ericholscher
Copy link
Member

@ericholscher ericholscher commented Mar 28, 2018

Thanks!

@ericholscher ericholscher merged commit af4e06d into readthedocs:master Mar 28, 2018
1 check passed
@gaborbernat gaborbernat deleted the tox branch Mar 28, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants