Skip to content

Fix docs build failure on Python 3.13+ by upgrading Sphinx#9506

Open
Mikyx-1 wants to merge 2 commits into
pytorch:mainfrom
Mikyx-1:fix/sphinx-imghdr-python313
Open

Fix docs build failure on Python 3.13+ by upgrading Sphinx#9506
Mikyx-1 wants to merge 2 commits into
pytorch:mainfrom
Mikyx-1:fix/sphinx-imghdr-python313

Conversation

@Mikyx-1
Copy link
Copy Markdown

@Mikyx-1 Mikyx-1 commented May 31, 2026

Summary

Fixes #9432.

docs/requirements.txt pinned sphinx==5.0.0, which imports imghdr via sphinx.util.images. The imghdr module was removed in Python 3.13, causing the docs build to fail immediately with:

Extension error:
Could not import extension sphinx.builders.epub3 (exception: No module named 'imghdr')

This PR upgrades the pin to sphinx>=7.0.0, the first major version that removed the imghdr dependency.

Changes

  • docs/requirements.txt: sphinx==5.0.0sphinx>=7.0.0

Test plan

  • Verified the error reproduces on Python 3.14 with sphinx==5.0.0
  • Verified make html-noplot completes successfully after the fix

🤖 Generated with Claude Code

sphinx==5.0.0 imports `imghdr` via sphinx.util.images, a stdlib module
removed in Python 3.13. Upgrading to sphinx>=7.0.0 removes this dependency.

Fixes pytorch#9432
@pytorch-bot
Copy link
Copy Markdown

pytorch-bot Bot commented May 31, 2026

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/vision/9506

Note: Links to docs will display an error until the docs builds have been completed.

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@meta-cla
Copy link
Copy Markdown

meta-cla Bot commented May 31, 2026

Hi @Mikyx-1!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

@meta-cla meta-cla Bot added the cla signed label May 31, 2026
@meta-cla
Copy link
Copy Markdown

meta-cla Bot commented May 31, 2026

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

CONTRIBUTING.md improvement: fail to build docs due to depricated imghdr

1 participant