Installation Guide

System Requirements

Python 3.7 or higher
pip package manager
Git (optional, for version control)

Step 1: Clone or Download the Project

git clone <repository-url>
cd doc

Step 2: Create Virtual Environment (Recommended)

# Windows
python -m venv venv
venv\Scripts\activate

# Linux/macOS
python3 -m venv venv
source venv/bin/activate

Step 3: Install Dependencies

pip install -r requirements.txt

Installed Packages

sphinx (6.0-8.0): Documentation generator
sphinx-rtd-theme (1.3.0+): Professional theme
myst-parser (1.0.0+): Markdown support
sphinx-togglebutton: Interactive toggle buttons

Step 4: Verify Installation

sphinx-build --version

You should see version 6.x or 7.x output.

Troubleshooting

Command Not Found: sphinx-build

Solution: Make sure your virtual environment is activated or add Python to PATH.

Permission Denied on Linux/macOS

chmod +x make

Module Not Found Errors

# Reinstall all dependencies
pip install --upgrade -r requirements.txt