A clean and modern Sphinx theme with polished API docs.
Project Links
Meta
Author: Aksiome
Requires Python: >=3.10
Classifiers
Development Status
- 4 - Beta
Framework
- Sphinx
- Sphinx :: Theme
License
- OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Operating System
- OS Independent
Programming Language
- Python
- Python :: 3
- Python :: 3.10
- Python :: 3.11
- Python :: 3.12
- Python :: 3.13
- Python :: 3.14
Topic
- Documentation
- Software Development :: Documentation
Sphinx Breeze Theme
A breath of fresh air for your Sphinx documentation
Live Demo · Get Started · Kitchen Sink
Why Breeze?
Breeze was built from scratch with a focus on generous spacing and clean typography. A lot of Sphinx themes can feel a bit cramped, so Breeze aims to give your content more room to breathe.
The name comes from the Minecraft Breeze mob, since this game is what got me into programming.
Features
- 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+.
pip install sphinx-breeze-theme
Quickstart
Add to your conf.py:
html_theme = "breeze"
That's it! For customization options, see the documentation.
Acknowledgements
Breeze draws inspiration from other great projects:
- PyData Sphinx Theme — Three-column layout with toctree tabs in the header
- Material for MkDocs — Overall aesthetic and modern visual direction
- Shibuya — Polish, extension support ideas, and configuration patterns
- VitePress — UI component inspiration
- Furo — Implementation reference for Sphinx code
- 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.
0.13.2
Mar 22, 2026
0.13.1
Feb 22, 2026
0.13.0
Feb 22, 2026
0.12.0
Feb 09, 2026
0.11.1
Feb 07, 2026
0.11.0
Feb 07, 2026
0.10.0
Feb 01, 2026
0.9.0
Jan 29, 2026
0.8.0
Jan 27, 2026
0.7.3
Jan 26, 2026
0.7.2
Jan 26, 2026
0.7.1
Jan 26, 2026
0.7.0
Jan 26, 2026
0.6.1
Jan 23, 2026
0.6.0
Nov 14, 2025
0.5.5
Nov 02, 2025
0.5.4
Nov 02, 2025
0.5.3
Nov 02, 2025
0.5.2
Oct 30, 2025
0.5.1
Oct 30, 2025
0.5.0
Oct 29, 2025
0.4.2
Oct 26, 2025
0.4.1
Oct 26, 2025
0.4.0
Oct 26, 2025
0.3.2
Oct 26, 2025
0.3.1
Oct 24, 2025
0.3.0
Oct 24, 2025
0.2.3
Oct 22, 2025
0.2.2
Oct 21, 2025
0.2.1
Oct 21, 2025
0.2.0
Oct 21, 2025
0.1.2
Oct 05, 2025
0.1.1
Sep 27, 2025
0.1.0
Sep 27, 2025
0.0.1
Sep 25, 2025
0.0.0
Sep 21, 2025
Wheel compatibility matrix
Files in release
Extras:
None
Dependencies:
accessible-pygments
beautifulsoup4
docutils
emoji
pygments
sphinx
(>=8.0)
sphinxext-opengraph[social-cards]
typing-extensions