🚀 Quickstart#

This is a short step-by-step tutorial to get started with the Sphinx Breeze Theme.

Installation#

Install Breeze from PyPI:

pip install sphinx-breeze-theme

uv add --dev sphinx-breeze-theme

Hint

If you’re new to Sphinx, we recommend reading the official tutorial for a solid understanding of the platform and its features.

Using Breeze#

Note

This documentation and the examples are written with MyST Markdown, a form of markdown that works with Sphinx. For more information about MyST markdown, and to use MyST markdown with your Sphinx website, see the MyST-parser documentation

Here’s a typical Sphinx docs setup. You can start from this layout and adapt it to your project.

  • <my_project>

    • docs

      • _static

      • _templates

      • conf.py

      • index.md

      • …

    • .readthedocs.yml

    • pyproject.toml

    • …

  • conf.py — sphinx configuration

  • index.md — your documentation homepage

  • _static/ (optional) — for static files

  • _templates/ (optional) — for templates

Enable the theme by updating html_theme in conf.py.

conf.py#
html_theme = "breeze"
...

Your documentation is now styled with Breeze!