CI: Pin to sphinx>=6.2 for docs build on Python 3.13 (#3667)

weiji14 · seisman · commit 548c867b7206 · 2024-12-03T21:15:50.000+08:00
Fix `ModuleNotFoundError: No module named 'imghdr'` on Python 3.13. Xref sphinx-doc/sphinx#10440 (comment) * Set needs_sphinx to 6.2
diff --git a/.github/workflows/ci_docs.yml b/.github/workflows/ci_docs.yml
@@ -111,7 +111,7 @@ jobs:
             python-build
             myst-nb
             panel
-            sphinx
+            sphinx>=6.2
             sphinx-autodoc-typehints
             sphinx-copybutton
             sphinx-design
diff --git a/ci/requirements/docs.yml b/ci/requirements/docs.yml
@@ -26,7 +26,7 @@ dependencies:
     # Dev dependencies (building documentation)
     - myst-nb
     - panel
-    - sphinx
+    - sphinx>=6.2
     - sphinx-autodoc-typehints
     - sphinx-copybutton
     - sphinx-design
diff --git a/doc/conf.py b/doc/conf.py
@@ -171,7 +171,7 @@
 ]
 
 source_suffix = ".rst"
-needs_sphinx = "1.8"
+needs_sphinx = "6.2"
 # Encoding of source files
 source_encoding = "utf-8-sig"
 root_doc = "index"
diff --git a/environment.yml b/environment.yml
@@ -37,7 +37,7 @@ dependencies:
     # Dev dependencies (building documentation)
     - myst-nb
     - panel
-    - sphinx
+    - sphinx>=6.2
     - sphinx-autodoc-typehints
     - sphinx-copybutton
     - sphinx-design
