Skip to content

Commit

Permalink
Add descriptions to tox environments
Browse files Browse the repository at this point in the history
With that we can expose the contributer to `tox -av` in the contributers
guidelines.
  • Loading branch information
agoscinski committed May 26, 2024
1 parent 95891fa commit 972c23d
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
7 changes: 6 additions & 1 deletion docs/src/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,12 @@ Then this package itself
pip install -e .
This install the package in development mode, making it importable globally and allowing
you to edit the code and directly use the updated version.
you to edit the code and directly use the updated version. To see a list of all
supported tox environments please use

.. code-block:: bash
tox -av
Running the tests
-----------------
Expand Down
5 changes: 4 additions & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ lint_folders =


[testenv:build]
# builds the package and checks integrity
description = Builds the package and checks integrity

usedevelop = true
deps =
Expand All @@ -29,6 +29,7 @@ commands =
check-manifest {toxinidir}

[testenv:tests]
description = Runs the tests
usedevelop = true
changedir = tests
deps =
Expand All @@ -51,6 +52,7 @@ commands_post =
coverage xml

[testenv:lint]
description = Checks the code and doc for programmatic and stylistic errors
skip_install = true
deps =
black
Expand Down Expand Up @@ -87,6 +89,7 @@ commands =
isort {[tox]lint_folders}

[testenv:docs]
description = Builds the documentation
usedevelop = true
deps =
-r docs/requirements.txt
Expand Down

0 comments on commit 972c23d

Please sign in to comment.