Skip to main content

A modern, accessible, and responsive Sphinx documentation theme.

Project description

Breeze - A Modern Sphinx Theme

A modern Sphinx theme built with TypeScript and Vite.

demo

Installation

Install Breeze from PyPI:

pip

pip install sphinx-breeze-theme

uv

uv add --dev sphinx-breeze-theme

Setup

Update conf.py:

html_theme = "breeze"

Customise header:

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

Documentation

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_breeze_theme-0.7.1.tar.gz (2.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinx_breeze_theme-0.7.1-py3-none-any.whl (2.2 MB view details)

Uploaded Python 3

File details

Details for the file sphinx_breeze_theme-0.7.1.tar.gz.

File metadata

  • Download URL: sphinx_breeze_theme-0.7.1.tar.gz
  • Upload date:
  • Size: 2.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sphinx_breeze_theme-0.7.1.tar.gz
Algorithm Hash digest
SHA256 a5cd7e633aedf7d37e40a91a6962f7736bd7b48b80ce7ac81d0a3d702cbae733
MD5 2a072af70c78e0aa7cfd2b11faa6698c
BLAKE2b-256 7ab6097805ca062755e57c120cdedd9208f5a729724ca334a87a16cf46a1fb29

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_breeze_theme-0.7.1.tar.gz:

Publisher: release.yml on aksiome/breeze

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sphinx_breeze_theme-0.7.1-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_breeze_theme-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dcf0b258a4a726d9d1426771f5205d9457c6e4cbbeb96722422c54ecb5975b6e
MD5 d79748c1018945e7bc2f8a8806b968f2
BLAKE2b-256 8d2d8bdc041ae976f95cf55ad61adca44a9b965679859031fde642e3b0c5b6ee

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_breeze_theme-0.7.1-py3-none-any.whl:

Publisher: release.yml on aksiome/breeze

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page