AcademySoftwareFoundation / AcademySoftwareFoundation/OpenTimelineIO

Update Sphinx pinned version to get newer python support and remove imghdr requirement

Open
#1,807 1 comment 0 reactions 0 assignees View on GitHub
build documentation good first issue
Dominant language
C++
Stars
2k
Forks
351
Avg merge
1d 12h
Merged PRs (30d)
1

Description

# Required:
------------
[ x] I believe this isn't a duplicate topic
[ x] This report is not related to an adapter

## Select One:

[ x] Build problem
[ ] Incorrect Functionality or bug
[ ] New feature or functionality

## Description

Building docs on Python 3.13 fails due to Sphinx pinned version requiring imghdr which is deprecated in newer python versions as of 3.13 (deprecated but available in 3.12)

## Environment

macOS 14.6 running conda env python 3.13

## Reproduction Steps

```
cd docs
pip install -r requirements
make html
```

fixed by installing python 3.12.

Contributor guide

Open the contributing guide

Research direction

Open docs/requirements and inspect the pinned Sphinx dependency and related requirements. Recreate the issue with Python 3.13 using pip install -r requirements and make html; done means the documentation build succeeds without requiring imghdr.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.