Estrutura do Projeto

Esse tópico tem a finalidade de apresentar a estrutura do projeto facilitando eventuais contribuidores.

O gerenciamento de pacote é feito com o uv. Dessa forma, apos fazer um git clone, basta dar o comando abaixo. Os grupos docs e dev instalam também as dependências relativas a documentação (que abordaremos a seguir) e aos pacotes de desenvolvimento (grosso modo: jupyter notebook para facilitar as tentativas de rodar).

uv sync --group docs --group dev

Uma vez com ambiente .venv criado, basta acessa-lo.

# Windows
.venv\Scripts\activate

# Linux
source .venv/bin/activate

A documentação é feita com o Material for MkDocs, com deploy no Read The Docs.

Para instanciar a documentação, basta dar um

mkdocs serve