Skip to content

Commit

Permalink
MAINT create a dev environment containing all dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
glemaitre committed May 18, 2024
1 parent 939dd4e commit 27d16e6
Show file tree
Hide file tree
Showing 3 changed files with 3,144 additions and 74 deletions.
17 changes: 17 additions & 0 deletions doc/quick_start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,23 @@ In addition, you have a linter task to check the code consistency in terms of st

pixi run lint

Activating the development environment
--------------------------------------

In the case that you don't want to use the `pixi run` commands and directly interact
with the usual python tools, you can activate the development environment:

.. prompt:: bash $

pixi shell -e dev

This will activate an environment containing the dependencies needed to run the linters,
tests, and build the documentation. So for instance, you can run the tests with:

.. prompt:: bash $

pytest -vsl skltemplate

Setup the continuous integration
--------------------------------

Expand Down
Loading

0 comments on commit 27d16e6

Please sign in to comment.