Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bumps sphinx and myst-parser pinned versions to play nicely with Python 3.13 #1815

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

benjamin-white-233
Copy link

@benjamin-white-233 benjamin-white-233 commented Nov 15, 2024

Link the Issue(s) this Pull Request is related to.

If there is an associated issue, link it in the form:

Fixes #1807

Use one line for each Issue. This allows auto-closing the related issue when the fix is merged.

Summarize your change.

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).

Bumping pinned versions sphinx==7.3.7 and myst-parser==3.0.1 allows building docs on Python 3.13.

Add a list of changes, and note any that might need special attention during review.

Reference associated tests.

If no new tests are introduced as part of this PR, note the tests that are providing coverage.

Copy link

CLA Missing ID CLA Not Signed

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.63%. Comparing base (c0e97b0) to head (93b5433).
Report is 29 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1815      +/-   ##
==========================================
- Coverage   84.11%   81.63%   -2.49%     
==========================================
  Files         198      176      -22     
  Lines       22241    12683    -9558     
  Branches     4687     2784    -1903     
==========================================
- Hits        18709    10354    -8355     
+ Misses       2610     1783     -827     
+ Partials      922      546     -376     
Flag Coverage Δ
py-unittests 81.63% <ø> (-2.49%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 123 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3a8bad4...93b5433. Read the comment docs.

@reinecke
Copy link
Collaborator

reinecke commented Dec 5, 2024

It looks like the build is failing on:

WARNING: Calling get_html_theme_path is deprecated. If you are calling it to define html_theme_path, you are safe to remove that code.

Perhaps this is a new deprecation in the updated versions?

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.

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