sphinx-phoebe-theme 0.1.0

Modern, responsive Sphinx theme with AI chat and feedback widgets

Sphinx Phoebe Theme

A modern, responsive Sphinx documentation theme with integrated AI chat and feedback widgets.

Features

• 🎨 Modern 3-column responsive layout
• 🌓 Dark mode with system detection
• 💬 Optional AI chat (RunLLM integration)
• 💌 Optional feedback widget (Formspree)
• ⌨️ Keyboard shortcuts
• 📱 Mobile-friendly
• 🔍 Enhanced search with cards

Quick Start

# Install
pip install -e git+https://github.com/justineheritage/sphinx-phoebe-theme.git#egg=sphinx-phoebe-theme

# Configure (conf.py)
html_theme = "sphinx_phoebe_theme"

extensions = [
    'sphinx_phoebe_theme.extensions.theme_helpers',
]

html_theme_options = {
    "nav_title": "My Docs",
    "color_primary": "#2c3e50",
    "color_accent": "#3498db",
}

# Build
make html

# Serve (required for search)
cd _build/html && python -m http.server 8000

Documentation

📚 Full Documentation →

• Installation Guide — Install from source or PyPI
• Quick Start — Get started in 5 minutes
• Configuration Reference — All theme options
• Features Overview — What's included
• AI Chat Setup — Enable RunLLM chat (optional)
• Basic Example — Working example project

Optional Features

AI Chat

See AI Chat Integration Guide for detailed setup.

import os

html_theme_options = {
    "chat_enabled": True,
    "chat_api_key": os.getenv("RUNLLM_API_KEY"),
    "chat_pipeline_id": int(os.getenv("RUNLLM_PIPELINE_ID")),
}

⚠️ Never commit API keys! Use environment variables.

Feedback Widget

import os

html_theme_options = {
    "feedback_enabled": True,
    "feedback_formspree_id": os.getenv("FORMSPREE_ID"),
}

Keyboard Shortcuts

• / — Focus search
• [ — Toggle sidebar
• ← → — Previous/next page
• ? — Show all shortcuts

Development Status

Version: 0.1.0 (Alpha)

• ✅ Phase 1: Security & Setup (Complete)
• 🚧 Phase 2: Documentation (In Progress)
• 📋 Phase 3: PyPI Release (Planned)

Requirements

• Python 3.8+
• Sphinx 4.0+

Browser Support

Chrome/Edge 90+, Firefox 88+, Safari 14+

Contributing

Issues and suggestions welcome! This project was extracted from production code at Corelight and is now open source.

License

MIT License

Links

• Documentation: docs/
• Example: examples/basic/
• Issues: https://github.com/justineheritage/sphinx-phoebe-theme/issues
• Repository: https://github.com/justineheritage/sphinx-phoebe-theme