https://github.com/aksiome/breeze
A clean and modern Sphinx theme with polished API docs
https://github.com/aksiome/breeze
breeze clean customizable documentation modern sphinx sphinx-doc sphinx-theme theme
Last synced: 3 months ago
JSON representation
A clean and modern Sphinx theme with polished API docs
- Host: GitHub
- URL: https://github.com/aksiome/breeze
- Owner: aksiome
- License: mpl-2.0
- Created: 2025-09-20T16:38:37.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2026-02-07T19:19:34.000Z (4 months ago)
- Last Synced: 2026-02-08T03:31:53.583Z (4 months ago)
- Topics: breeze, clean, customizable, documentation, modern, sphinx, sphinx-doc, sphinx-theme, theme
- Language: CSS
- Homepage: https://sphinx-breeze-theme.readthedocs.io/
- Size: 1.78 MB
- Stars: 6
- Watchers: 1
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/contributing/index.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Sphinx Breeze Theme
A clean and modern Sphinx theme with polished API docs
Live Demo ·
Get Started ·
Kitchen Sink
## Why Breeze?
- **Clear and readable** — Tuned typography and spacing that lets your content breathe
- **Polished API docs** — First-class autodoc styling that's easy to navigate
- **Accessible** — WCAG-friendly colors and syntax highlighting out of the box
- **Adaptive** — Works on any device with light & dark themes
- **Built to scale** — Multiple layouts, built-in components, and flexible customization
## Installation
Requires Python 3.10+ and Sphinx 8.0+.
```bash
pip install sphinx-breeze-theme
```
## Quickstart
Add to your `conf.py`:
```python
html_theme = "breeze"
```
That's it! For customization options, see the [documentation](https://sphinx-breeze-theme.readthedocs.io/).
## Acknowledgements
Breeze draws inspiration from other great projects:
- [PyData Sphinx Theme](https://github.com/pydata/pydata-sphinx-theme) — Three-column layout with toctree tabs in the header
- [Material for MkDocs](https://github.com/squidfunk/mkdocs-material) — Overall aesthetic and modern visual direction
- [Shibuya](https://github.com/lepture/shibuya) — Polish, extension support ideas, and configuration patterns
- [VitePress](https://github.com/vuejs/vitepress) — UI component inspiration
- [Furo](https://github.com/pradyunsg/furo) — Implementation reference for Sphinx code
- [Lutra](https://github.com/pradyunsg/lutra) — A three-column theme that inspired this project
This project is tested with BrowserStack. Shoutout to them for supporting OSS projects!
## License
This project is licensed under the [MPL-2.0](LICENSE) License.