Merge branch 'shibuya-theme' into 'main'

feat: use the shibuya documentation theme

See merge request yaal/canaille!168

CHANGES.rst

@@ -10,6 +10,7 @@ Changed
 - Bump to htmx 1.99.11 :pr:`166`
 - Use the standard tomllib python module instead of `toml` starting from python 3.11 :pr:`167`
 - Add `created` and `last_modified` datetime for all models
+- Use shibuya as the documentation theme
 
 [0.0.42] - 2023-12-29
 =====================

doc/conf.py

@@ -65,9 +65,21 @@ issues_commit_uri = "https://gitlab.com/yaal/canaille/-/commit/{commit}"
 
 # -- Options for HTML output ----------------------------------------------
 
-html_theme = "sphinx_rtd_theme"
+html_theme = "shibuya"
 html_static_path = []
-
+html_theme_options = {
+    "accent_color": "yellow",
+    "gitlab_url": "https://gitlab.com/yaal/canaille",
+    "mastodon_url": "https://toot.aquilenet.fr/@yaal",
+    "nav_links": [
+        {
+            "title": "Homepage",
+            "url": "https://canaille.yaal.coop",
+            "summary": "The homepage for the Canaille project",
+        },
+        {"title": "PyPI", "url": "https://pypi.org/project/Canaille/"},
+    ],
+}
 
 # -- Options for HTMLHelp output ------------------------------------------
 

poetry.lock

@@ -1458,7 +1458,6 @@ files = [
     {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"},
     {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"},
     {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"},
-    {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a08c6f0fe150303c1c6b71ebcd7213c2858041a7e01975da3a99aed1e7a378ef"},
     {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"},
     {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"},
     {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"},
@@ -1580,6 +1579,20 @@ docs = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "pygments
 testing = ["build[virtualenv]", "filelock (>=3.4.0)", "importlib-metadata", "ini2toml[lite] (>=0.9)", "jaraco.develop (>=7.21)", "jaraco.envs (>=2.2)", "jaraco.path (>=3.2.0)", "mypy (==1.9)", "packaging (>=23.2)", "pip (>=19.1)", "pytest (>=6)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-home (>=0.5)", "pytest-mypy (>=0.9.1)", "pytest-perf", "pytest-ruff (>=0.2.1)", "pytest-timeout", "pytest-xdist (>=3)", "tomli", "tomli-w (>=1.0.0)", "virtualenv (>=13.0.0)", "wheel"]
 testing-integration = ["build[virtualenv] (>=1.0.3)", "filelock (>=3.4.0)", "jaraco.envs (>=2.2)", "jaraco.path (>=3.2.0)", "packaging (>=23.2)", "pytest", "pytest-enabler", "pytest-xdist", "tomli", "virtualenv (>=13.0.0)", "wheel"]
 
+[[package]]
+name = "shibuya"
+version = "2024.3.1"
+description = "A clean, responsive, and customizable Sphinx documentation theme with light/dark mode."
+optional = false
+python-versions = ">=3.7"
+files = [
+    {file = "shibuya-2024.3.1-py3-none-any.whl", hash = "sha256:c70fa64120175ac782ba04ff5c45736e1fe10cc01afb74f9e305b3408af2498a"},
+    {file = "shibuya-2024.3.1.tar.gz", hash = "sha256:8dad19bb9f85a5c25270a5dea62aaf8ae97daf4fa546df476931847f1b1bbe4e"},
+]
+
+[package.dependencies]
+Sphinx = "*"
+
 [[package]]
 name = "six"
 version = "1.16.0"
@@ -1698,25 +1711,6 @@ sphinx = "*"
 dev = ["pre-commit (>=3.6,<4.0)", "sphinx-issues[tests]", "tox"]
 tests = ["pytest"]
 
-[[package]]
-name = "sphinx-rtd-theme"
-version = "2.0.0"
-description = "Read the Docs theme for Sphinx"
-optional = false
-python-versions = ">=3.6"
-files = [
-    {file = "sphinx_rtd_theme-2.0.0-py2.py3-none-any.whl", hash = "sha256:ec93d0856dc280cf3aee9a4c9807c60e027c7f7b461b77aeffed682e68f0e586"},
-    {file = "sphinx_rtd_theme-2.0.0.tar.gz", hash = "sha256:bd5d7b80622406762073a04ef8fadc5f9151261563d47027de09910ce03afe6b"},
-]
-
-[package.dependencies]
-docutils = "<0.21"
-sphinx = ">=5,<8"
-sphinxcontrib-jquery = ">=4,<5"
-
-[package.extras]
-dev = ["bump2version", "sphinxcontrib-httpdomain", "transifex-client", "wheel"]
-
 [[package]]
 name = "sphinxcontrib-applehelp"
 version = "1.0.4"
@@ -1762,20 +1756,6 @@ files = [
 lint = ["docutils-stubs", "flake8", "mypy"]
 test = ["html5lib", "pytest"]
 
-[[package]]
-name = "sphinxcontrib-jquery"
-version = "4.1"
-description = "Extension to include jQuery on newer Sphinx releases"
-optional = false
-python-versions = ">=2.7"
-files = [
-    {file = "sphinxcontrib-jquery-4.1.tar.gz", hash = "sha256:1620739f04e36a2c779f1a131a2dfd49b2fd07351bf1968ced074365933abc7a"},
-    {file = "sphinxcontrib_jquery-4.1-py2.py3-none-any.whl", hash = "sha256:f936030d7d0147dd026a4f2b5a57343d233f1fc7b363f68b3d4f1cb0993878ae"},
-]
-
-[package.dependencies]
-Sphinx = ">=1.8"
-
 [[package]]
 name = "sphinxcontrib-jsmath"
 version = "1.0.1"
@@ -2132,4 +2112,4 @@ sql = ["passlib", "sqlalchemy", "sqlalchemy-json", "sqlalchemy-utils"]
 [metadata]
 lock-version = "2.0"
 python-versions = "^3.8"
-content-hash = "812f97ff8a162310df85100383de335d0c53f06b1d12a4ac9fb5145ff51789dc"
+content-hash = "8ae8b74a082bc9c3fab61ec59c021f4856fefb07cc3555f1eee085fe32e5e0bb"

pyproject.toml

@@ -69,8 +69,8 @@ sqlalchemy-utils = {version = "^0.41.1", optional=true}
 optional = true
 
 [tool.poetry.group.doc.dependencies]
+shibuya = "^2024.3.1"
 sphinx = "^7.0.0"
-sphinx-rtd-theme = "^2.0.0"
 sphinx-issues = "^4.0.0"
 
 [tool.poetry.group.dev.dependencies]