Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Fix docs CI on Python 3.14 by upgrading Sphinx#7175

Merged
bentsherman merged 1 commit into
masterfrom
fix-docs-ci-python-3.14
May 26, 2026
Merged

Fix docs CI on Python 3.14 by upgrading Sphinx#7175
bentsherman merged 1 commit into
masterfrom
fix-docs-ci-python-3.14

Conversation

@jorgee

@jorgee jorgee commented May 26, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Sphinx 5.x imports the stdlib imghdr module, removed in Python 3.13 (PEP 594). After CI bumped to Python 3.14.5 the docs build fails on import sphinx.builders.epub3ModuleNotFoundError: No module named 'imghdr'.
  • Bump Sphinx (5.3.0 → 8.2.3) and the companion packages that depend on it to versions that no longer rely on imghdr: myst-parser, sphinx-rtd-theme, sphinxcontrib-mermaid, sphinxext-rediraffe, sphinx-tabs.
  • Also trigger the Docs CI workflow when the workflow file itself (.github/workflows/docs.yml) is edited — docs/** already covers docs/requirements.txt.

Test plan

  • Reproduced the imghdr failure locally in a fresh Python 3.14 venv with the previous pins.
  • Replicated the exact CI flow (pip install -r requirements.txt + make clean html) in a fresh Python 3.14 venv with the new pins — build succeeds.
  • Confirm Docs CI passes on this PR.

🤖 Generated with Claude Code

Sphinx 5.x imports the stdlib `imghdr` module, which was removed
in Python 3.13 (PEP 594). After CI bumped to Python 3.14.5 the
docs build fails on `import sphinx.builders.epub3`.

Upgrade Sphinx and the companion packages that depend on it to
versions that no longer rely on `imghdr`. Also trigger the Docs
CI workflow when the workflow file itself is edited.

Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
Signed-off-by: jorgee <[email protected]>
@jorgee jorgee requested a review from a team as a code owner May 26, 2026 08:47
@netlify

netlify Bot commented May 26, 2026

Copy link
Copy Markdown

Deploy Preview for nextflow-docs-staging ready!

Name Link
🔨 Latest commit 02fba60
🔍 Latest deploy log https://app.netlify.com/projects/nextflow-docs-staging/deploys/6a155e3069afe90008b3359c
😎 Deploy Preview https://deploy-preview-7175--nextflow-docs-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@jorgee jorgee requested review from bentsherman and pditommaso May 26, 2026 08:49
@ewels

ewels commented May 26, 2026

Copy link
Copy Markdown
Member

I think we can probably just delete the docs CI now? We're not using Sphinx any more and I believe that @christopher-hakkaart will soon update the markdown contained in this repo to be compliant with Docusaurus, which will just break the CI again.

@bentsherman bentsherman merged commit 71665de into master May 26, 2026
26 checks passed
@bentsherman bentsherman deleted the fix-docs-ci-python-3.14 branch May 26, 2026 14:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants