From b07b4e21cda9339cc9fb6f0f96a86d897d5e7c91 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Eduard=20=C5=A0ubert?= <6988280+edasubert@users.noreply.github.com> Date: Thu, 1 Feb 2024 11:48:31 +0100 Subject: [PATCH] Update README: mention how to run tests (#121) --- README.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.rst b/README.rst index 5f8e8ab4..a1fc5f0e 100644 --- a/README.rst +++ b/README.rst @@ -104,6 +104,18 @@ API Documentation The API documentation can be found on `ReadTheDocs `_. +Running the tests +================= + +Testing is set up using `tox`: + +.. code-block:: bash + + pip install tox + + tox -e py3 # runs the tests + tox -e lint # runs the format checks + Funding & Acknowledgements ==========================