Fix `SyntaxWarnings` when building the docs

ManimCommunity / manim

A community-maintained Python framework for creating mathematical animations.

https://www.manim.community

MIT License

26.81k stars 1.84k forks source link

Fix `SyntaxWarnings` when building the docs #3924

Open JasonGrace2282 opened 2 months ago

JasonGrace2282 commented 2 months ago

Bump readthedocs to use python 3.12 (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

behackl commented 1 month ago

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 commented 1 month ago

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