Santai SDK

Setup

uv sync

Documentation

Build and view the documentation locally:

# Install with documentation dependencies
uv sync --extra docs

# Serve docs locally with live reload
uv run mkdocs serve

# Build static documentation to site/
uv run mkdocs build

The documentation is automatically generated from source code docstrings using mkdocstrings. To update the docs, simply enhance the docstrings in the source code and rebuild.

Visit http://127.0.0.1:8000 after running mkdocs serve to view the docs.

Development

This project uses several programmatic tools for code quality. Read the documentation on some of these tools to understand their functionality and basic commands for running quality checks.

uv tool install codespell
uv tool install ruff
uv tool install rumdl
uv tool install ty

This project also uses pre-commit (prek) for ensuring that each commit passes the code quality checks. See the pre-commit configuration

uv tool install prek

Quality Checks

Run code quality checks before committing:

# Format code
uv run ruff format

# Lint code
uv run ruff check --fix

# Check spelling
uv tool run codespell

# Lint markdown
uv tool run rumdl docs/