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

Fix SyntaxWarnings when building the docs and bump readthedocs to Python 3.13 #3924

Merged
merged 9 commits into from
Dec 16, 2024

Conversation

JasonGrace2282
Copy link
Member

@JasonGrace2282 JasonGrace2282 commented Sep 1, 2024

  • Bump readthedocs to use python 3.12 3.13 (so it's easier to confirm there being no SyntaxWarning without having to build it)
  • Use raw strings to avoid syntax warnings
  • Don't access the deprecated .tags attribute so that we can upgrade to Sphinx 9.0 without problems in the future

@JasonGrace2282 JasonGrace2282 added the maintenance refactoring, typos, removing clutter/dead code, and other code quality improvements label Sep 1, 2024
@JasonGrace2282 JasonGrace2282 added this to the v0.20.0 milestone Sep 1, 2024
@JasonGrace2282 JasonGrace2282 marked this pull request as draft September 1, 2024 16:53
@JasonGrace2282 JasonGrace2282 marked this pull request as ready for review September 2, 2024 18:00
@behackl behackl modified the milestones: v0.20.0, v0.19.0 Oct 19, 2024
@behackl
Copy link
Member

behackl commented Oct 19, 2024

Curiously, this change apparently bumps up our documentation build time by about 2 minutes -- I can't really tell why.

Should we try to bump the version of Python directly to 3.13 to see whether it makes a difference?

@JasonGrace2282
Copy link
Member Author

We could try bumping to 3.13. I'm not sure if that would make it faster, though - there was an issue with 3.13 that made it 30% slower with Sphinx. Python reverted the change, but it's possible it could still be slower.

I'm all for trying, though!

For reference, the build times are:
Python 3.11 - 16min 23s
Python 3.12 - 17min 56s

@JasonGrace2282
Copy link
Member Author

JasonGrace2282 commented Dec 9, 2024

It did get slightly faster with python 3.13, with 15min 45 seconds!

Copy link
Contributor

@chopan050 chopan050 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@chopan050 chopan050 changed the title Fix SyntaxWarnings when building the docs Fix SyntaxWarnings when building the docs and bump readthedocs to Python 3.13 Dec 16, 2024
@chopan050 chopan050 enabled auto-merge (squash) December 16, 2024 15:52
@chopan050 chopan050 merged commit 112c99b into ManimCommunity:main Dec 16, 2024
20 of 21 checks passed
JasonGrace2282 added a commit to JasonGrace2282/manim that referenced this pull request Dec 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance refactoring, typos, removing clutter/dead code, and other code quality improvements
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants