From 6d5028e066e642a00cd9aa1fc3d37d73df71f604 Mon Sep 17 00:00:00 2001 From: Wei Ji <23487320+weiji14@users.noreply.github.com> Date: Tue, 3 Dec 2024 10:42:05 +1300 Subject: [PATCH 1/2] Pin to sphinx>=6.2 Fix `ModuleNotFoundError: No module named 'imghdr'` on Python 3.13. Xref https://github.com/sphinx-doc/sphinx/issues/10440#issuecomment-1556180835 --- .github/workflows/ci_docs.yml | 2 +- ci/requirements/docs.yml | 2 +- environment.yml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/ci_docs.yml b/.github/workflows/ci_docs.yml index 1b7933ddcaa..736ba5fe6c6 100644 --- a/.github/workflows/ci_docs.yml +++ b/.github/workflows/ci_docs.yml @@ -110,7 +110,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 index 5902672fba5..cf929454499 100644 --- a/ci/requirements/docs.yml +++ b/ci/requirements/docs.yml @@ -25,7 +25,7 @@ dependencies: # Dev dependencies (building documentation) - myst-nb - panel - - sphinx + - sphinx>=6.2 - sphinx-autodoc-typehints - sphinx-copybutton - sphinx-design diff --git a/environment.yml b/environment.yml index 38073e7fc7d..0f2ab565cf2 100644 --- 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 From 223c0fb9eb651c89fab9efee829ef224ee1fabc0 Mon Sep 17 00:00:00 2001 From: Wei Ji <23487320+weiji14@users.noreply.github.com> Date: Tue, 3 Dec 2024 17:49:08 +1300 Subject: [PATCH 2/2] Set needs_sphinx to 6.2 --- doc/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/conf.py b/doc/conf.py index 613c860aa75..2b41acd3f61 100644 --- 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"