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

Update sphinx #3070

Merged
merged 5 commits into from
Aug 25, 2024
Merged

Update sphinx #3070

merged 5 commits into from
Aug 25, 2024

Conversation

A5rocks
Copy link
Contributor

@A5rocks A5rocks commented Aug 23, 2024

I was looking at #2921 and wondering why Sphinx wasn't getting updated. Turns out they dropped support for Python 3.8. However, our RTD build runs in Python 3.11 so we can use that for the docs requirements.

@A5rocks
Copy link
Contributor Author

A5rocks commented Aug 23, 2024

/home/docs/checkouts/readthedocs.org/user_builds/trio/checkouts/3070/src/trio/abc.py:docstring of trio.abc.Channel:1: WARNING: py:class reference target not found: trio._abc.SendChannel
/home/docs/checkouts/readthedocs.org/user_builds/trio/checkouts/3070/src/trio/abc.py:docstring of trio.abc.Channel:1: WARNING: py:class reference target not found: trio._abc.ReceiveChannel
/home/docs/checkouts/readthedocs.org/user_builds/trio/checkouts/3070/src/trio/__init__.py:docstring of trio.SocketListener:1: WARNING: py:class reference target not found: trio._abc.Listener
/home/docs/checkouts/readthedocs.org/user_builds/trio/checkouts/3070/src/trio/__init__.py:docstring of trio.SSLListener:1: WARNING: py:class reference target not found: trio._abc.Listener
/home/docs/checkouts/readthedocs.org/user_builds/trio/checkouts/3070/src/trio/__init__.py:docstring of trio.SSLListener:1: WARNING: py:class reference target not found: trio._ssl.SSLStream
/home/docs/checkouts/readthedocs.org/user_builds/trio/checkouts/3070/src/trio/__init__.py:docstring of trio.DTLSChannel:1: WARNING: py:class reference target not found: trio._abc.Channel
/home/docs/checkouts/readthedocs.org/user_builds/trio/checkouts/3070/src/trio/lowlevel.py:docstring of trio.lowlevel.Task.iter_await_frames:1: WARNING: py:class reference target not found: types.FrameType

Copy link

codecov bot commented Aug 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.63%. Comparing base (6f614ec) to head (3cfd9b3).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3070   +/-   ##
=======================================
  Coverage   99.63%   99.63%           
=======================================
  Files         121      121           
  Lines       17850    17855    +5     
  Branches     3208     3208           
=======================================
+ Hits        17784    17789    +5     
  Misses         46       46           
  Partials       20       20           
Files Coverage Δ
src/trio/_abc.py 100.00% <100.00%> (ø)
src/trio/_ssl.py 100.00% <100.00%> (ø)

@A5rocks
Copy link
Contributor Author

A5rocks commented Aug 23, 2024

Ok most of those is that Sphinx doesn't seem to like referencing a superclass. That makes no sense!

Somehow the changes are from sphinx-doc/sphinx@1ff9adf. Because it's trying to refer to the classes it derives from and then tries getting them from _abc.... I hate updating Sphinx.

@A5rocks
Copy link
Contributor Author

A5rocks commented Aug 23, 2024

OK filed python/cpython#123250, but there's things we can do to work around this.

@CoolCat467 CoolCat467 added the skip newsfragment Newsfragment is not required label Aug 23, 2024
Copy link
Member

@CoolCat467 CoolCat467 left a comment

Choose a reason for hiding this comment

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

Looks good. python/cpython#123250 is quite interesting, I hope there will be a fix eventually. I was wondering while looking at this, any particular reason to use 3.11 over 3.12 now that we are upgrading?

@A5rocks
Copy link
Contributor Author

A5rocks commented Aug 25, 2024

No, just when we changed the version I think it wasn't supported by RTD.

Copy link
Member

@jakkdl jakkdl left a comment

Choose a reason for hiding this comment

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

sad to need ugly workarounds, but seems worth it

docs-requirements.in Outdated Show resolved Hide resolved
@CoolCat467 CoolCat467 merged commit 64e731d into python-trio:main Aug 25, 2024
37 of 38 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip newsfragment Newsfragment is not required
Projects
None yet
Development

Successfully merging this pull request may close these issues.

When bumping sphinx, remove FrameType workaround in docs/source/conf.py
3 participants