File tree Expand file tree Collapse file tree 1 file changed +40
-1
lines changed
Expand file tree Collapse file tree 1 file changed +40
-1
lines changed Original file line number Diff line number Diff line change 11# Breeze - A Modern Sphinx Theme
22
3- A modern Sphinx theme built with TypeScript and Vite.
3+ A modern Sphinx theme built with TypeScript and Vite.
4+
5+
6+
7+ [ demo] ( https://sphinx-breeze-theme.readthedocs.io/en/stable/ )
8+
9+ ## Installation
10+
11+ Install Breeze from [ PyPI] ( https://pypi.org/project/sphinx-breeze-theme/ ) :
12+
13+ pip
14+ ``` bash
15+ pip install sphinx-breeze-theme
16+ ```
17+
18+ uv
19+ ``` bash
20+ uv add --dev sphinx-breeze-theme
21+ ```
22+
23+ ## Setup
24+
25+ Update `` conf.py `` :
26+ ``` python
27+ html_theme = " breeze"
28+ ```
29+
30+ Customise header:
31+ ``` python
32+ html_context = {
33+ " github_user" : " aksiome" ,
34+ " github_repo" : " breeze" ,
35+ ...
36+ }
37+ ```
38+
39+ ## Documentation
40+
41+ - official sphinx [ tutorial] ( https://www.sphinx-doc.org/en/master/tutorial/ )
42+ - MyST markdown [ documentation] ( https://myst-parser.readthedocs.io/ )
You can’t perform that action at this time.
0 commit comments