Metadata-Version: 2.4
Name: sphinx-phoebe-theme
Version: 0.1.0
Summary: Modern, responsive Sphinx theme with AI chat and feedback widgets
Author-email: Justine Heritage <justineheritage@users.noreply.github.com>
License: MIT
Project-URL: Homepage, https://github.com/justineheritage/sphinx-phoebe-theme
Project-URL: Repository, https://github.com/justineheritage/sphinx-phoebe-theme
Project-URL: Issues, https://github.com/justineheritage/sphinx-phoebe-theme/issues
Keywords: sphinx,theme,documentation,ai,chat
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Theme
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development :: Documentation
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: sphinx>=4.0
Dynamic: license-file

# Sphinx Phoebe Theme

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

![License](https://img.shields.io/badge/license-MIT-blue.svg)
![Python](https://img.shields.io/badge/python-3.8+-blue.svg)
![Sphinx](https://img.shields.io/badge/sphinx-4.0+-blue.svg)

## 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

```bash
# 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 →](docs/)**

- **[Installation Guide](docs/installation.md)** — Install from source or PyPI
- **[Quick Start](docs/quickstart.md)** — Get started in 5 minutes
- **[Configuration Reference](docs/configuration.md)** — All theme options
- **[Features Overview](docs/features.md)** — What's included
- **[AI Chat Setup](docs/chat-integration.md)** — Enable RunLLM chat (optional)
- **[Basic Example](examples/basic/)** — Working example project

## Optional Features

### AI Chat

See **[AI Chat Integration Guide](docs/chat-integration.md)** for detailed setup.

```python
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

```python
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](LICENSE)

## Links

- **Documentation:** [docs/](docs/)
- **Example:** [examples/basic/](examples/basic/)
- **Issues:** https://github.com/justineheritage/sphinx-phoebe-theme/issues
- **Repository:** https://github.com/justineheritage/sphinx-phoebe-theme
