docs

:orphan:

Kailash Python SDK Documentation

This directory contains the public documentation for the Kailash Python SDK.

Structure

• *.rst - Sphinx source files for API documentation
• api/ - API reference documentation
• _static/ - Static assets for documentation
• Makefile - Build commands
• conf.py - Sphinx configuration
• build_docs.py - Documentation build script

Building Documentation

Prerequisites

• Python 3.11+
• pip

Build for GitHub Pages

The easiest way to build the documentation for GitHub Pages:

cd docs
python build_docs.py

This will:

1. Install required dependencies
2. Build the Sphinx documentation
3. Prepare files for GitHub Pages deployment

Manual Build

To build documentation manually:

cd docs
pip install -r requirements.txt
make html

The built documentation will be in docs/_build/html/.

Deploying to GitHub Pages

1. Build the documentation using the script above
2. Commit the generated files
3. Configure GitHub Pages in repository settings

The repository includes a GitHub Actions workflow that automatically builds and deploys documentation when changes are pushed to the main branch.