Breeze - A Modern Sphinx Theme

A modern Sphinx theme built with TypeScript and Vite.

Installation

Install Breeze from PyPI:

pip

pip install sphinx-breeze-theme

uv

uv add --dev sphinx-breeze-theme

Update conf.py:

html_theme = "breeze"

Customise header:

html_context = {
    "github_user": "aksiome",
    "github_repo": "breeze",
    ...
}

Name		Name	Last commit message	Last commit date
Latest commit History 77 Commits
.github/workflows		.github/workflows
docs		docs
src/sphinx_breeze_theme		src/sphinx_breeze_theme
.editorconfig		.editorconfig
.gitignore		.gitignore
.readthedocs.yml		.readthedocs.yml
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.md		README.md
noxfile.py		noxfile.py
package-lock.json		package-lock.json
package.json		package.json
pyproject.toml		pyproject.toml
tsconfig.json		tsconfig.json
vite.config.js		vite.config.js