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.
1 maintainer
Metadata
1 maintainer
Release files for sphinx-breeze-theme 0.13.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_breeze_theme-0.13.2.tar.gz | 4.3 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_breeze_theme-0.13.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 8.2 MB
Release files / sphinx_breeze_theme-0.13.2.tar.gz
| Download URL | sphinx_breeze_theme-0.13.2.tar.gz |
|---|---|
| Size | 4.3 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6cb2b6c26524970d04080b86f603cf723887f2ac8d02ec0a4d5266b49f816e3f
|
|
BLAKE2b-256 checksum How to use checksums |
80ebaa03f10751f97a436249f498dac2c34d70badeeafd20c6a886a9846579c5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 22, 2026.
Transparency logRelease files / sphinx_breeze_theme-0.13.2-py3-none-any.whl
| Download URL | sphinx_breeze_theme-0.13.2-py3-none-any.whl |
|---|---|
| Size | 4.0 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ea008094e5fddaf9fad109475e8bc8742cb183b13dc529b233a090e07bc43fb5
|
|
BLAKE2b-256 checksum How to use checksums |
28286873e0bc3693971a2e2feff67be2288bec5b8432cc57be9174ee9cb8b83e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 22, 2026.
Transparency log
