Setting Up Programming Environment

All platforms use uv for dependency management.

Prerequisites

Install uv

# Linux / macOS
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows (PowerShell)
irm astral.sh/uv/install.ps1 | iex

After installation, ensure uv is in your PATH.

Setup Environment

Clone the repository and navigate to the directory corresponding to the module:

cd <evita-module>

Install dependencies and sync the environment:

uv sync

This creates a virtual environment and installs all project dependencies from pyproject.toml.

Build Documentation

Using Make (Linux / macOS)

# Build HTML documentation
uv run make html

# Build with live reload for local development
uv run make livehtml

The make html target builds static HTML in the _build directory. The make livehtml target starts a server with live reload at http://localhost:8000.

Windows (without Make)

# Build HTML documentation
uv run sphinx-build -M html content _build

# Build with live reload for local development
uv run sphinx-autobuild content _build

Platform-Specific Notes

Linux

No additional steps required. Ensure curl is available.

macOS

No additional steps required. Ensure curl is available.

Windows

Use PowerShell for the commands above. Git Bash should also work. For live reload, ensure port 8000 is available.