Skip to content

Environment¶

This document describes how to configure and use your development environment.

Note

All terminal commands listed below are assumed to be run from the root of the repository.

Initial setup¶

Install Python 3.10.
Install poetry.
Install dependencies of this project by running this command:
```
poetry install
```

Running the tests¶

Run this command:
```
poetry run pytest
```

Serving the documentation¶

Start the server by running this command:
```
poetry run mkdocs serve
```
Check the command output for the URL of the created site and open it in a browser (usually localhost:8000).

You can keep the server running while you edit the documentation. The server will automatically rebuild and reload the site when you save changes.