VABS-Doc

VABS documentation

Setup with uv

This project uses uv for dependency management.

Installation

1. Install uv:

   # On macOS and Linux
   curl -LsSf https://astral.sh/uv/install.sh | sh
   
   # On Windows
   powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
   
   # Or with pip
   pip install uv

2. Install project dependencies:

   uv sync

3. Activate the virtual environment:

   # On Unix/Linux/macOS
   source .venv/bin/activate
   
   # On Windows
   .venv/Scripts/activate.ps1

Building Documentation

Build the documentation using the provided scripts or direct uv commands:

# Using the build script (recommended)
scripts/build.bat    # On Windows
scripts/build.sh     # On Unix/Linux/macOS

# Or using direct uv commands
uv run sphinx-build -M html source build    # Build HTML documentation
uv run sphinx-build -M clean source build   # Clean build directory

# Serve docs locally on http://localhost:8000
uv run python -m http.server 8000 --directory build/html

# Or using traditional make commands (if make is available)
make html
make clean

Development

Install development dependencies:

uv sync --extra dev

Run development tools:

# Format code
uv run black .

# Sort imports
uv run isort .

# Lint code
uv run flake8 .