Skip to content

Commit

Permalink
Update the discussion of tox
Browse files Browse the repository at this point in the history
  • Loading branch information
pnkraemer committed Apr 23, 2024
1 parent 90a36a4 commit a4c11f5
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions docs/source/docs_dev/continuous_integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,23 @@ Install `tueplots` with all ci-related dependencies via
```
pip install .[ci]
```


## Tox
Run all checks via
```
tox
```
or only run the tests via
```
tox -e pytest
tox -e test
```
or use tox (which also runs the linter, and the python-code-snippets in this readme).
```
tox
or only run the linter via
```commandline
tox -e format-and-lint
```

## Pre-commit hook
The CI checks for compliance of the code with black and isort, and runs the tests and the notebooks.
To automatically satisfy the former, there is a pre-commit that can be used (do this once):
```
Expand Down

0 comments on commit a4c11f5

Please sign in to comment.