Skip to content

Commit c5968e0

Browse files
committed
fix docs
1 parent 58c60bf commit c5968e0

File tree

4 files changed

+23
-22
lines changed

4 files changed

+23
-22
lines changed

docs/source/_static/.gitkeep

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Keep this directory in version control
2+
# Sphinx expects _static directory to exist for static assets

docs/source/conf.py

Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -69,10 +69,7 @@
6969

7070
# The suffix(es) of source filenames.
7171
# You can specify multiple suffix as a list of string:
72-
source_suffix = {
73-
'.rst': None,
74-
'.md': None,
75-
}
72+
source_suffix = ['.rst', '.md']
7673

7774
# The master toctree document.
7875
master_doc = 'index'
@@ -135,33 +132,31 @@
135132
# The theme to use for HTML and HTML Help pages. See the documentation for
136133
# a list of builtin themes.
137134
#
138-
html_theme = 'sphinx_rtd_theme'
135+
html_theme = 'furo'
139136

140137
# Theme options are theme-specific and customize the look and feel of a theme
141138
# further. For a list of options available for each theme, see the
142139
# documentation.
143140
#
144-
# html_theme_options = {}
141+
html_theme_options = {
142+
"sidebar_hide_name": True,
143+
"light_css_variables": {
144+
"color-brand-primary": "#2563eb",
145+
"color-brand-content": "#2563eb",
146+
},
147+
"dark_css_variables": {
148+
"color-brand-primary": "#3b82f6",
149+
"color-brand-content": "#3b82f6",
150+
},
151+
}
145152

146153
# Add any paths that contain custom static files (such as style sheets) here,
147154
# relative to this directory. They are copied after the builtin static files,
148155
# so a file named "default.css" will overwrite the builtin "default.css".
149156
html_static_path = ['_static']
150157

151-
# Custom sidebar templates, must be a dictionary that maps document names
152-
# to template names.
153-
#
154-
# This is required for the alabaster theme
155-
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
156-
html_sidebars = {
157-
'**': [
158-
'about.html',
159-
'navigation.html',
160-
'relations.html', # needs 'show_related': True theme option to display
161-
'searchbox.html',
162-
'donate.html',
163-
]
164-
}
158+
# Furo doesn't need custom sidebar configuration
159+
# html_sidebars = {}
165160

166161

167162
# -- Options for HTMLHelp output ------------------------------------------

docs/source/installation.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,11 @@ pip install "allocator[docs]"
9191

9292
Includes:
9393
- `sphinx` ≥7.0.0 - Documentation generator
94-
- `sphinx-rtd-theme`1.3.0 - Read the Docs theme
94+
- `furo`2023.9.10 - Additional functionality
9595
- `myst-parser` ≥2.0.0 - Markdown support for Sphinx
96+
- `linkify-it-py` ≥2.0.0 - Additional functionality
9697
- `sphinx-autodoc-typehints` ≥1.24.0 - Type hints in API docs
98+
- `sphinx-design` ≥0.5.0 - Additional functionality
9799

98100
## Complete Installation
99101

pyproject.toml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,11 @@ test = [
9595
]
9696
docs = [
9797
"sphinx>=7.0.0",
98-
"sphinx-rtd-theme>=1.3.0",
98+
"furo>=2023.9.10", # Modern Sphinx theme
9999
"myst-parser>=2.0.0", # Markdown support
100+
"linkify-it-py>=2.0.0", # Required for MyST linkify extension
100101
"sphinx-autodoc-typehints>=1.24.0",
102+
"sphinx-design>=0.5.0", # Modern design components
101103
]
102104

103105
# Convenience groups

0 commit comments

Comments
 (0)