Sphinx cleanups, bump version requirements, typecheck docs source files#2909
Merged
jakkdl merged 3 commits intopython-trio:masterfrom Dec 21, 2023
Merged
Sphinx cleanups, bump version requirements, typecheck docs source files#2909jakkdl merged 3 commits intopython-trio:masterfrom
jakkdl merged 3 commits intopython-trio:masterfrom
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 |
TeamSpen210
reviewed
Dec 20, 2023
| ) | ||
|
|
||
| # Sphinx is very finicky, and somewhat buggy, so we have several different | ||
| # methods to help it resolve links. |
Contributor
There was a problem hiding this comment.
Might want to mention the typevar module also, which redirects typing_extensions → typing, and all typevars to typing.TypeVar etc.
TeamSpen210
reviewed
Dec 20, 2023
CoolCat467
approved these changes
Dec 20, 2023
Member
CoolCat467
left a comment
There was a problem hiding this comment.
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!
TeamSpen210
approved these changes
Dec 21, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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