Metadata-Version: 2.4
Name: sphinx-breeze-theme
Version: 0.7.3
Summary: A modern, accessible, and responsive Sphinx documentation theme.
Project-URL: Homepage, https://github.com/aksiome/breeze
Project-URL: Repository, https://github.com/aksiome/breeze
Project-URL: Documentation, https://sphinx-breeze-theme.readthedocs.io/
Project-URL: Issues, https://github.com/aksiome/breeze/issues
Author-email: Aksiome <54895777+aksiome@users.noreply.github.com>
License: MPL-2.0
License-File: LICENSE
Keywords: breeze,design,documentation,html-theme,sphinx,sphinx-theme,theme
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Theme
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Requires-Python: >=3.10
Requires-Dist: accessible-pygments
Requires-Dist: beautifulsoup4
Requires-Dist: docutils
Requires-Dist: emoji
Requires-Dist: pygments
Requires-Dist: sphinx>=8.0
Requires-Dist: sphinxext-opengraph
Requires-Dist: typing-extensions
Description-Content-Type: text/markdown

# Breeze - A Modern Sphinx Theme

A modern Sphinx theme built with TypeScript and Vite. 



[demo](https://sphinx-breeze-theme.readthedocs.io/en/stable/)

## Installation

Install Breeze from [PyPI](https://pypi.org/project/sphinx-breeze-theme/):

pip
```bash
pip install sphinx-breeze-theme
```

uv
```bash
uv add --dev sphinx-breeze-theme
```

## Setup

Update ``conf.py``:
```python
html_theme = "breeze"
```

Customise header:
```python
html_context = {
    "github_user": "aksiome",
    "github_repo": "breeze",
    ...
}
```

## Documentation

- official sphinx [tutorial](https://www.sphinx-doc.org/en/master/tutorial/)
- MyST markdown [documentation](https://myst-parser.readthedocs.io/)
