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.6.1.tar.gz (90.5 kB 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.6.1-py3-none-any.whl (92.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_breeze_theme-0.6.1.tar.gz
  • Upload date:
  • Size: 90.5 kB
  • 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.6.1.tar.gz
Algorithm Hash digest
SHA256 3391dd3c30ec29a60b0fdfee093a9ae9685a15396f23eb1c7746e052e7505d76
MD5 da260d530d409457c951d48cb1a55db0
BLAKE2b-256 0b1d9bed41706f6545f767f9471acb15cbd4b97c4bdcb9d0b3ff296dbc3d3d6a

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_breeze_theme-0.6.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.6.1-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_breeze_theme-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 67f8deccdc6a339bfa672726c0e03d463a377650c805ea93644f6008f2b8620a
MD5 41066f75493fc0582a39528344be2b14
BLAKE2b-256 24ec24a3445f33bd613112ad4692d0631ac3b185a7b9f2d92e8e047c528a9d45

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_breeze_theme-0.6.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