Getting Started

Quick Start in 5 Minutes

1. Install Dependencies

pip install -r requirements.txt

2. Build the Documentation

Windows:

make.bat html

Linux/macOS:

make html

3. View the Documentation

Open build/html/index.html in your browser.

Or use Python’s built-in server:

python -m http.server 8000 --directory build/html

Then visit: http://localhost:8000

What’s Next?

Key Files

File

Purpose

requirements.txt

Python dependencies

Makefile (Linux/macOS)

Build commands

make.bat (Windows)

Build commands for Windows

source/conf.py

Sphinx configuration

source/index.rst

Main documentation index