Local Setup

Prerequisites

• Python 3.9+

• pip

Installation

# Clone the repository
git clone https://github.com/prashanthkadasi/pi-docs.git
cd pi-docs

# Create virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

Build Locally

# Build HTML documentation
make html

# Or on Windows without make
sphinx-build -b html . _build/html

# Open _build/html/index.html in your browser

Live Preview

For live preview during development:

pip install sphinx-autobuild
sphinx-autobuild . _build/html --open-browser

Tip

The live preview will automatically refresh when you save changes.