Skip to content

Commit

Permalink
Merge pull request #1087 from burningmantech/2023-01-15-abr-docs-tweak
Browse files Browse the repository at this point in the history
docs: change to working tox command
  • Loading branch information
wsanchez authored Jan 22, 2024
2 parents 30b3809 + d217b1b commit 44aeadb
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,13 @@ Running the Test Suite
~~~~~~~~~~~~~~~~~~~~~~

This project uses Tox_ for running tests.

If you do not have tox installed, the recommended way is to use pipx_::

python3 -m pip install pipx
pipx install tox
pipx upgrade tox

To run all of the default test environments::

tox run
Expand Down Expand Up @@ -68,8 +75,9 @@ Pull requests in GitHub will run all tests on Travis CI, and all are required to

.. ------------------------------------------------------------------------- ..
.. _Twisted: https://twistedmatrix.com/
.. _Klein: https://klein.readthedocs.io/
.. _Tox: http://tox.readthedocs.io/
.. _Flake8: http://flake8.pycqa.org/
.. _Klein: https://klein.readthedocs.io/
.. _Mypy: http://mypy.readthedocs.io/
.. _pipx: https://pipx.pypa.io/stable/
.. _Tox: http://tox.readthedocs.io/
.. _Twisted: https://twistedmatrix.com/

0 comments on commit 44aeadb

Please sign in to comment.