Skip to content

Commit 3d4d848

Browse files
Vitexuswarp-agent
andcommitted
docs: Switch to shibuya theme with compatibility fixes
Configure documentation to use the shibuya theme (python3-shibuya-sphinx-theme) with proper compatibility fixes. Changes: - Switched html_theme from alabaster to shibuya - Added monkey patch to fix incompatibility between shibuya's hardcoded pygments styles (github-light-default, github-dark-default) and available pygments version - Override ShibuyaPygmentsBridge class attributes to use available styles: * light_style_name: default * dark_style_name: github-dark - Configured shibuya theme options with GitHub URL and navigation links - Enabled dark_code option for better code syntax highlighting Build Status: - Documentation builds successfully ✅ - 226 warnings (existing legacy content formatting) - Shibuya theme renders correctly with proper light/dark mode support This resolves the pygments.util.ClassNotFound error for 'github-dark-default' style and enables the modern shibuya theme for MultiFlexi documentation. Co-Authored-By: Warp <agent@warp.dev>
1 parent fffe737 commit 3d4d848

1 file changed

Lines changed: 17 additions & 6 deletions

File tree

docs/source/conf.py

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Configuration file for the Sphinx documentation builder.
22

3+
# Monkey patch shibuya to use available pygments styles
4+
import shibuya._pygments
5+
# Override shibuya's default styles with available ones
6+
shibuya._pygments.ShibuyaPygmentsBridge.light_style_name = "default"
7+
shibuya._pygments.ShibuyaPygmentsBridge.dark_style_name = "github-dark"
8+
39
# -- Project information
410

511
project = 'MultiFlexi'
@@ -47,16 +53,21 @@
4753

4854
# -- Options for HTML output
4955

50-
html_theme = "alabaster"
56+
html_theme = "shibuya"
5157

52-
# Pygments styling
58+
# Pygments styling - use valid styles for light and dark modes
5359
pygments_style = "default"
60+
pygments_dark_style = "github-dark" # Use available github-dark instead of github-dark-default
5461

5562
html_theme_options = {
56-
'github_user': 'VitexSoftware',
57-
'github_repo': 'MultiFlexi',
58-
'github_button': True,
59-
'github_type': 'star',
63+
"github_url": "https://github.com/VitexSoftware/MultiFlexi",
64+
"dark_code": True,
65+
"nav_links": [
66+
{
67+
"title": "GitHub",
68+
"url": "https://github.com/VitexSoftware/MultiFlexi",
69+
},
70+
],
6071
}
6172

6273
# Show source links

0 commit comments

Comments
 (0)