|
1 | | -# Breeze - A Modern Sphinx Theme |
| 1 | +<p align="center"> |
| 2 | + <img src="docs/_static/logo.png" alt="Breeze" width="100" height="100"> |
| 3 | +</p> |
2 | 4 |
|
3 | | -A modern Sphinx theme built with TypeScript and Vite. |
| 5 | +<h1 align="center">Breeze</h1> |
4 | 6 |
|
| 7 | +<p align="center"> |
| 8 | + <strong>A clean and modern Sphinx theme with polished API docs</strong> |
| 9 | +</p> |
5 | 10 |
|
| 11 | +<p align="center"> |
| 12 | + <a href="https://pypi.org/project/sphinx-breeze-theme/"><img src="https://img.shields.io/pypi/v/sphinx-breeze-theme?color=%2334D058" alt="PyPI version"></a> |
| 13 | + <a href="https://pypistats.org/packages/sphinx-breeze-theme"><img src="https://img.shields.io/pypi/dm/sphinx-breeze-theme.svg" alt="Downloads"/></a> |
| 14 | + <a href="https://sphinx-breeze-theme.readthedocs.io/"><img src="https://img.shields.io/readthedocs/sphinx-breeze-theme" alt="Documentation"></a> |
| 15 | + <a href="https://github.com/aksiome/breeze/blob/main/LICENSE"><img src="https://img.shields.io/pypi/l/sphinx-breeze-theme" alt="License"></a> |
| 16 | +</p> |
6 | 17 |
|
7 | | -[demo](https://sphinx-breeze-theme.readthedocs.io/en/stable/) |
| 18 | +<p align="center"> |
| 19 | + <a href="https://sphinx-breeze-theme.readthedocs.io/">Live Demo</a> · |
| 20 | + <a href="https://sphinx-breeze-theme.readthedocs.io/en/stable/user_guide/quickstart.html">Get Started</a> · |
| 21 | + <a href="https://sphinx-breeze-theme.readthedocs.io/en/stable/kitchen-sink/">Kitchen Sink</a> |
| 22 | +</p> |
| 23 | + |
| 24 | +<p align="center"> |
| 25 | + <picture> |
| 26 | + <source media="(prefers-color-scheme: dark)" srcset="docs/_static/screenshot-dark.png"> |
| 27 | + <source media="(prefers-color-scheme: light)" srcset="docs/_static/screenshot-light.png"> |
| 28 | + <img alt="Breeze theme screenshot" src="docs/_static/screenshot-light.png"> |
| 29 | + </picture> |
| 30 | +</p> |
| 31 | + |
| 32 | + |
| 33 | +## Why Breeze? |
| 34 | + |
| 35 | +- **Clear and readable** — Tuned typography and spacing that lets your content breathe |
| 36 | +- **Polished API docs** — First-class autodoc styling that's easy to navigate |
| 37 | +- **Accessible** — WCAG-friendly colors and syntax highlighting out of the box |
| 38 | +- **Adaptive** — Works on any device with light & dark themes |
| 39 | +- **Built to scale** — Multiple layouts, built-in components, and flexible customization |
8 | 40 |
|
9 | 41 | ## Installation |
10 | 42 |
|
11 | | -Install Breeze from [PyPI](https://pypi.org/project/sphinx-breeze-theme/): |
| 43 | +Requires Python 3.10+ and Sphinx 8.0+. |
12 | 44 |
|
13 | | -pip |
14 | 45 | ```bash |
15 | 46 | pip install sphinx-breeze-theme |
16 | 47 | ``` |
17 | 48 |
|
18 | | -uv |
19 | | -```bash |
20 | | -uv add --dev sphinx-breeze-theme |
21 | | -``` |
| 49 | +## Quickstart |
22 | 50 |
|
23 | | -## Setup |
| 51 | +Add to your `conf.py`: |
24 | 52 |
|
25 | | -Update ``conf.py``: |
26 | 53 | ```python |
27 | 54 | html_theme = "breeze" |
28 | 55 | ``` |
29 | 56 |
|
30 | | -Customise header: |
31 | | -```python |
32 | | -html_context = { |
33 | | - "github_user": "aksiome", |
34 | | - "github_repo": "breeze", |
35 | | - ... |
36 | | -} |
37 | | -``` |
| 57 | +That's it! For customization options, see the [documentation](https://sphinx-breeze-theme.readthedocs.io/). |
| 58 | + |
| 59 | +## Acknowledgements |
| 60 | + |
| 61 | +Breeze draws inspiration from other great projects: |
| 62 | + |
| 63 | +- [PyData Sphinx Theme](https://github.com/pydata/pydata-sphinx-theme) — Three-column layout with toctree tabs in the header |
| 64 | +- [Material for MkDocs](https://github.com/squidfunk/mkdocs-material) — Overall aesthetic and modern visual direction |
| 65 | +- [Shibuya](https://github.com/lepture/shibuya) — Polish, extension support ideas, and configuration patterns |
| 66 | +- [VitePress](https://github.com/vuejs/vitepress) — UI component inspiration |
| 67 | +- [Furo](https://github.com/pradyunsg/furo) — Implementation reference for Sphinx code |
| 68 | +- [Lutra](https://github.com/pradyunsg/lutra) — A three-column theme that inspired this project |
38 | 69 |
|
39 | | -## Documentation |
| 70 | +## License |
40 | 71 |
|
41 | | -- official sphinx [tutorial](https://www.sphinx-doc.org/en/master/tutorial/) |
42 | | -- MyST markdown [documentation](https://myst-parser.readthedocs.io/) |
| 72 | +This project is licensed under the [MPL-2.0](LICENSE) License. |
0 commit comments