The documentation about the using of this material is available on https://hsandmann.github.io/spring/.

To use the code in this repository, follow the instructions below:

Create a virtual environment at Python:

python3 -m venv env

Activate the virtual environment (you must do this every time you run a script from this repository):

source ./env/bin/activate

Install the dependencies with:

pip3 install -r requirements.txt

The material uses mkdocs to generate the documentation. To view the documentation, run the command:

mkdocs serve

To release the documentation to GitHub Pages, run the command:

mkdocs gh-deploy