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

Missing typing_extensions when building docs on Python 3.8 #3093

Closed
jugmac00 opened this issue Aug 17, 2023 · 5 comments · Fixed by #3097
Closed

Missing typing_extensions when building docs on Python 3.8 #3093

jugmac00 opened this issue Aug 17, 2023 · 5 comments · Fixed by #3097
Labels
help:wanted Issues that have been acknowledged, a solution determined and a PR might likely be accepted.

Comments

@jugmac00
Copy link
Member

Issue

tox -e docs

causes the following warning

WARNING: Failed guarded type import with ModuleNotFoundError("No module named 'typing_extensions'")
WARNING: Cannot resolve forward reference in type annotations of "tox.config.loader.section.Section.from_key": name 'Self' is not defined
WARNING: Failed guarded type import with ModuleNotFoundError("No module named 'typing_extensions'")

Environment

Provide at least:

  • OS:

Ubuntu 20.04
Python 3.8

@jugmac00
Copy link
Member Author

A couple of thoughts... either we require typing-extensions for building docs, or we need to set a basepython for the docs env which does not require the typing-extensions any more.

@jugmac00 jugmac00 added the help:wanted Issues that have been acknowledged, a solution determined and a PR might likely be accepted. label Aug 17, 2023
@gaborbernat
Copy link
Member

The docs are meant to be build on latest (currently 3.11) Python. Anything else is just not supported.

@jugmac00
Copy link
Member Author

tox has no concept of latest, so do you mind setting basepython = python3.11, at least once pradyunsg/furo#693 has been fixed?

@gaborbernat
Copy link
Member

Well hopefully you're installing tox into latest Python, that way you do get latest...

@jugmac00
Copy link
Member Author

Actually, I dit not until now. Usually I use the Python version which comes along with the Ubuntu LTS I am using for all the tools.

While I just re-installed tox with Python 3.11, I do not think it is a pleasant experience for people contributing to our documentation to encounter various error messages, and only then be told to use the latest Python version.

Read the Docs defaults to Python 3.11 ( https://blog.readthedocs.com/migrate-configuration-v2/#additional-help ), so imho it makes a lot of sense to also use basepython = python3.11 for the docs env.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help:wanted Issues that have been acknowledged, a solution determined and a PR might likely be accepted.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants