Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TheBB committed Feb 16, 2024
1 parent 3938805 commit dad7960
Showing 1 changed file with 24 additions and 12 deletions.
36 changes: 24 additions & 12 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,30 @@ Don't upload wheels to PyPI manually. They are built by CI runners whenever a
new version is tagged (see below).


Tests
-----

To run the tests, use::

make test

To run specific parts of the tests, use::

make pytest
make mypy
make lint-check

The lint-check stage of the tests will complain about linter and style errors.
Some of these can be fixed automatically. To do this, run::

make lint
make format

For benchmarks::

make benchmark


Documentation
-------------

Expand All @@ -89,18 +113,6 @@ To push generated docs online on the ``gh-pages`` branch, run the helper script:
where ``remote`` is the name of the remote to push to. If not given, it will be asked.


Tests
-----

To run the tests, use::

make test

For benchmarks::

make bench


Releasing
---------

Expand Down

0 comments on commit dad7960

Please sign in to comment.