Skip to content

Commit

Permalink
docs: add how to run the tests and build the doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Guts committed Dec 7, 2023
1 parent ee7ce2a commit 317ac36
Showing 1 changed file with 19 additions and 4 deletions.
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Following initiative from the author of Material for MkDocs, this plugin provide
Clone the repository:
```bash
```sh
# install development dependencies
python -m pip install -U -r requirements/development.txt
# alternatively: pip install -e .[dev]
Expand All @@ -77,18 +77,33 @@ python -m pip install -e .

# install git hooks
pre-commit install
```

Then follow the [contribution guidelines](CONTRIBUTING.md).

### Run the tests

```sh
# install development dependencies
python -m pip install -U -r requirements/testing.txt
# alternatively: pip install -e .[test]

# run tests
pytest
```

### Build the documentation

```sh
# install dependencies for documentation
python -m pip install -U -r requirements/documentation.txt
# alternatively: pip install -e .[doc]
```

Then follow the [contribution guidelines](CONTRIBUTING.md).
# build the documentation
mkdocs build
```

## Release workflow
### Release workflow

1. Fill the `CHANGELOG.md`
1. Change the version number in `__about__.py`
Expand Down

0 comments on commit 317ac36

Please sign in to comment.