-
-
Notifications
You must be signed in to change notification settings - Fork 341
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
Bump RTD builder Python version #2817
base: main
Are you sure you want to change the base?
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2817 +/- ##
=======================================
Coverage 99.68% 99.68%
=======================================
Files 117 117
Lines 17546 17546
Branches 3152 3152
=======================================
Hits 17490 17490
Misses 38 38
Partials 18 18 |
What might be better is to just hardcode the older URL for this specific link. I just disabled the link and added a deprecation warning in #2815... |
Ack I didn't read that PR yet. Ideally we would use an old intersphinx inventory but still link to the latest version of the Python documentation... but I'm not sure if that's possible. Personally I would super duper rather just build our docs on 3.12 but unfortunately RTD doesn't support that yet. I think your solution is more pragmatic though (while it's probably more correct to not have a mismatch... it's not worth linking to older docs). I have to think about this a bit xd |
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.
Looks simple enough, but I feel like @TeamSpen210's solution in #2815 might be better in the end, and then we aren't dependent on "has to run docs on py3.11 only"
I've gone ahead and submitted readthedocs/readthedocs.org#10808 which might help things along |
Figured out an even better solution. We can just add an event listener which manually adds the definition into intersphinx's list of objects, with a 3.11 URL. Actually that probably would work for most of the other entries in |
That sounds like a plan. I'm not comfortable enough with Sphinx to do that though... maybe you could? :P |
/home/docs/checkouts/readthedocs.org/user_builds/trio/checkouts/2817/trio/__init__.py:docstring of trio.Path:1: WARNING: py:meth reference target not found: pathlib.Path.link_to Didn't it get removed? It was deprecated since 3.10. |
How about replacing the reference with https://webknjaz.github.io/intersphinx-untangled/docs.python.org/ |
FYI it is entirely possible to add several intersphinx entries against different python version docs. |
TBF this isn't really needed anymore due to fixes elsewhere, but this also (should, IIRC RTD releases on Tuesdays) bumps our builder to 3.12. |
We should wait until RTD does run on 3.12 - |
Only one issue from read the docs build: src/trio/__init__.py:docstring of trio.Path:1: WARNING: py:obj reference target not found: . |
Yeah I'm not sure if I even want to merge this PR anymore because it brings up so many possible issues (such as old forwarded methods not appearing in documentation). I'll just set it to WIP for a bit at least. |
old forwarded issues are relatively straightforward to add exceptions for in |
This is erroring on master due to (AFAICT) trio doing magic to make Sphinx realize
link_to
exists, but then using Python 3.12's Sphinx index to find it (which obviously doesn't work).This does raise the interesting question of whether functions that are removed will show up in the output, as we cannot expect everyone to be using Python 3.12. I'm not sure what to do about this.