Skip to content

Commit 7934c02

Browse files
committed
Docs: Change theme to Shibuya
1 parent f6939ad commit 7934c02

File tree

5 files changed

+30
-79
lines changed

5 files changed

+30
-79
lines changed

docs/changelog.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,11 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
1010

1111
### Changed
1212

13-
* Move from Rye to [uv](https://astral.sh/uv).
14-
* Move back from mkdocs to Sphinx (with Furo theme).
13+
* Move from Rye to [uv](https://astral.sh/uv) for project management.
14+
* Move back from mkdocs to Sphinx (with [Shibuya](https://shibuya.lepture.com)
15+
theme).
1516
* Rework documentation structure for improved navigation and search.
16-
* Deploy docs on Read The Docs.
17+
* Deploy docs on [Read The Docs](https://joseki.readthedocs.io/).
1718
* Allow Numpy 2.
1819
* Support Python 3.13.
1920

docs/conf.py

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -44,25 +44,14 @@
4444
# -- Options for HTML output -------------------------------------------------
4545
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
4646

47-
html_theme = "furo"
48-
47+
html_theme = "shibuya"
4948
html_theme_options = {
50-
"source_repository": "https://github.com/rayference/joseki/",
51-
"source_branch": "main",
52-
"source_directory": "docs/",
53-
"light_css_variables": {
54-
"color-brand-primary": "#2563eb",
55-
"color-brand-content": "#2563eb",
56-
},
57-
"dark_css_variables": {
58-
"color-brand-primary": "#60a5fa",
59-
"color-brand-content": "#60a5fa",
60-
},
61-
"light_logo": "logo_title-light.svg",
62-
"dark_logo": "logo_title-dark.svg",
63-
"sidebar_hide_name": True,
49+
"github_url": "https://github.com/rayference/joseki/",
50+
"accent_color": "violet",
51+
"light_logo": "_static/logo_title-light.svg",
52+
"dark_logo": "_static/logo_title-dark.svg",
53+
"navigation_with_keys": True,
6454
}
65-
6655
html_static_path = ["_static"]
6756
html_title = "Joseki"
6857

docs/requirements.txt

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# This file was autogenerated by uv via the following command:
22
# uv export --frozen --no-hashes --output-file=docs/requirements.txt
33
-e .
4-
accessible-pygments==0.0.5
5-
# via furo
64
alabaster==0.7.16 ; python_full_version < '3.10'
75
# via sphinx
86
alabaster==1.0.0 ; python_full_version >= '3.10'
@@ -38,9 +36,7 @@ babel==2.17.0
3836
# jupyterlab-server
3937
# sphinx
4038
beautifulsoup4==4.13.4
41-
# via
42-
# furo
43-
# nbconvert
39+
# via nbconvert
4440
bleach==6.2.0
4541
# via nbconvert
4642
certifi==2025.7.14
@@ -113,7 +109,6 @@ fonttools==4.59.0
113109
# via matplotlib
114110
fqdn==1.5.1
115111
# via jsonschema
116-
furo==2025.7.19
117112
h11==0.16.0
118113
# via
119114
# httpcore
@@ -360,8 +355,6 @@ pycparser==2.22
360355
# via cffi
361356
pygments==2.19.2
362357
# via
363-
# accessible-pygments
364-
# furo
365358
# ipython
366359
# ipython-pygments-lexers
367360
# nbconvert
@@ -438,6 +431,7 @@ send2trash==1.8.3
438431
# via jupyter-server
439432
setuptools==80.9.0
440433
# via jupyterlab
434+
shibuya==2025.7.24
441435
six==1.17.0
442436
# via
443437
# python-dateutil
@@ -451,31 +445,27 @@ soupsieve==2.7
451445
sphinx==7.4.7 ; python_full_version < '3.10'
452446
# via
453447
# autodocsumm
454-
# furo
455448
# myst-parser
449+
# shibuya
456450
# sphinx-autoapi
457451
# sphinx-autobuild
458452
# sphinx-autodoc-typehints
459-
# sphinx-basic-ng
460453
# sphinx-copybutton
461454
# sphinxcontrib-bibtex
462455
sphinx==8.1.3 ; python_full_version >= '3.10'
463456
# via
464457
# autodocsumm
465-
# furo
466458
# myst-parser
459+
# shibuya
467460
# sphinx-autoapi
468461
# sphinx-autobuild
469462
# sphinx-autodoc-typehints
470-
# sphinx-basic-ng
471463
# sphinx-copybutton
472464
# sphinxcontrib-bibtex
473465
sphinx-autoapi==3.6.0
474466
sphinx-autobuild==2024.10.3
475467
sphinx-autodoc-typehints==2.3.0 ; python_full_version < '3.10'
476468
sphinx-autodoc-typehints==3.0.1 ; python_full_version >= '3.10'
477-
sphinx-basic-ng==1.0.0b2
478-
# via furo
479469
sphinx-copybutton==0.5.2
480470
sphinxcontrib-applehelp==2.0.0
481471
# via sphinx

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,6 @@ relative-imports-order = "closest-to-furthest"
8080
dev = [
8181
"autodocsumm>=0.2.14",
8282
"coverage>=7.1.0",
83-
"furo>=2024.1.29",
8483
"ipykernel>=6.21.0",
8584
"ipython>=8.9.0",
8685
"jupyterlab>=3.5.3",
@@ -90,6 +89,7 @@ dev = [
9089
"nbstripout>=0.6.1",
9190
"pytest>=7.2.1",
9291
"seaborn>=0.13.2",
92+
"shibuya>=2025.7.24",
9393
"sphinx-autoapi>=3.6.0",
9494
"sphinx-autobuild>=2024.10.3",
9595
"sphinx-autodoc-typehints>=1.25.0",

uv.lock

Lines changed: 15 additions & 44 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)