Skip to content

Commit cd4a432

Browse files
committed
Add conf.py comment and require Sphinx>=8.2.3
- Add explanatory comment for override_image_directive=False setting explaining it's required for RST badge :target: option support - Update sphinx>=8.2.3 in docs optional dependency (highest version compatible with furo's sphinx<9.0 constraint) Note: This work was completed with AI assistance (Claude Code).
1 parent 1a37b5d commit cd4a432

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

docs/conf.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,9 @@ def use_aio():
174174
]
175175

176176
# -- sphinxcontrib-images Configuration --------------------------------------
177+
# NOTE: override_image_directive must be False to preserve standard RST image
178+
# directive :target: option support, which is required for clickable badge
179+
# substitutions in docs/index.rst (e.g., |PyPI| |Python| |CI| etc.)
177180
images_config = {
178181
"override_image_directive": False,
179182
"default_image_width": "80%",

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ dev-latest = [
102102
# Documentation tools (used by RTD via .readthedocs.yaml)
103103
docs = [
104104
# Core Sphinx + MyST
105-
"sphinx>=7.2",
105+
"sphinx>=8.2.3",
106106
"myst-parser>=2.0",
107107

108108
# Theme

0 commit comments

Comments
 (0)