How-To Guides

Using Make in This Project

This project uses make to automate various tasks. Below are the available commands and their descriptions:

To set up the project, run:

make setup

This will check if uv is installed and set up the project environment.

To build the project, run:

make build

This will check the code, run tests, and build the package.

To run the tests, use:

make test

This will run the tests excluding those marked as slow.

To run all tests, use:

make test_all

To clean the project, run:

make clean

This will remove the virtual environment, build files, and cache.

To format the project files, run:

make format

This will format the files using ruff.

To check the project files, run:

make check

This will check the files using ruff.

To check the typing, run:

make type

This will check the typing using mypy.

To build the documentation, run:

make docs

To serve the documentation locally, run:

make docs_serve

To upload the documentation, run:

make docs_upload