-
-
Notifications
You must be signed in to change notification settings - Fork 345
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
Sphinx cleanups, bump version requirements, typecheck docs source files #2909
Conversation
…eck with mypy in pyproject.toml, change sphinx version limits to >5.3, clean up & fix a bunch of references in sphinx, add comment explaining workarounds
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2909 +/- ##
==========================================
+ Coverage 99.49% 99.66% +0.16%
==========================================
Files 115 115
Lines 17704 17667 -37
Branches 3158 3157 -1
==========================================
- Hits 17615 17608 -7
+ Misses 70 40 -30
Partials 19 19 |
@@ -41,6 +49,20 @@ | |||
check=True, | |||
) | |||
|
|||
# Sphinx is very finicky, and somewhat buggy, so we have several different | |||
# methods to help it resolve links. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Might want to mention the typevar
module also, which redirects typing_extensions
→ typing
, and all typevars to typing.TypeVar
etc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good to me. I'm hopeful this will help with working with sphinx in the future, it's errors are confusing to me!
I was struggling with sphinx in #2898 and noticed that sphinx was pinned to an ancient version, and unpinning & updating it seemed to fix a couple of them. My struggles also made me understand sphinx innards better than I had before, so could fix a bunch of references at the same time.
let's see if RTD manages this as well