sphinx-breeze-theme 0.13.2

A clean and modern Sphinx theme with polished API docs.

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.