-
Notifications
You must be signed in to change notification settings - Fork 445
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
build: add python 3.12 checks alongside 3.8 #1008
Conversation
The docs build failure seems to be an old one #775 (comment). I will attempt a shot at fixing it. |
The docs build issue mainly happens because Sphinx is not able to correctly identify
|
eba31d4
to
bb54353
Compare
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.
Remove changelog entry and we are good to go.
@@ -0,0 +1 @@ | |||
- [Feature] Add Python 3.12 CI and `make docs` compatibility (by @DawoudSheraz) |
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.
CI-only changes don't warrant a changelog.
Basically, to decide whether a change needs a changelog entry, we need to place ourselves in the position of the typical Tutor user: platform administrator or plugin developer. Whenever they upgrade, we expect that they have a look at the changelog entries. We don't want them to worry unnecessarily about changes that won't impact them. But we do want to highlight the features that they might want to use and the breaking changes.
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.
Ok.
bb54353
to
1f422c8
Compare
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.
lgtm!
For #1006
Description
make docs
in Python 3.12make docs
in Python 3.12 was failing for various reasons for variety of items (Action, Filter, FilterCallbackFunc). Mainly, the generictype
does not get translated topy:class
and is instead picked up aspy:data
. There were a few issues on Sphinx and some related items on Stackoverflow. Everyone handled it differently in some capacity. One suggestion was to ignore some of the type params but it did not result in docs building as expected (#1008 (comment)). The appropriate fix for "Action & Filter" was to add entries in autodoc_type_aliases. FilterCallbackFunc was needed to be ignore because it does not translate to a py:class.