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

When bumping sphinx, remove FrameType workaround in docs/source/conf.py #2921

Open
jakkdl opened this issue Jan 10, 2024 · 0 comments
Open

Comments

@jakkdl
Copy link
Member

jakkdl commented Jan 10, 2024

github.com/sphinx-doc/sphinx/issues/11802
sphinx-doc/sphinx#11861
being fixed should make

trio/docs/source/conf.py

Lines 200 to 203 in d1cc062

# `types.FrameType.__module__` is "builtins", so sphinx looks for
# builtins.FrameType.
# See https://github.com/sphinx-doc/sphinx/issues/11802
add_mapping("class", "types", "FrameType")

redundant. Though I had some issues with getting TracebackType working with their workaround previously:

# sphinx will *only* work if we use types.TracebackType, and import
# *inside* TYPE_CHECKING. No other combination works.....
import types

that'll probably be the case with FrameType as well - and if so we should probably investigate and open an issue in sphinx about it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant