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

Add direct dependency on ipykernel #226

Merged
merged 2 commits into from
Dec 4, 2023

Conversation

garrison
Copy link
Contributor

@garrison garrison commented Aug 1, 2023

ipywidgets 8.1.0 has been released, which includes the change at jupyter-widgets/ipywidgets#3811. With this change, ipykernel is no longer a dependency of ipywidgets, so jupyer-sphinx must now depend on ipykernel directly rather than assume it will be installed as a transitive dependency of ipywidgets. Without this change, jupyter-sphinx tests will fail CI. This has additionally led to CI failures in some packages that depend on jupyter-sphinx but not ipykernel.

The minimum version chosen here is the same minimum version that was formerly specified by ipywidgets until jupyter-widgets/ipywidgets#3811.

ipywidgets 8.1.0 has been released, which includes the change at
jupyter-widgets/ipywidgets#3811.
With this change, ipykernel is no longer a dependnecy of ipywidgets,
so jupyer-sphinx must now depend on ipykernel directly rather
than assume it will be installed as a transitive dependency of
ipywidgets.  Without this change, jupyter-sphinx tests will fail CI.
This has additionally led to CI failures in some packages that
depend on jupyter-sphinx but not ipykernel.
@bnavigator
Copy link

You're editing the wrong file. The relevant dependency definition is in setup.py

jupyter-sphinx/setup.py

Lines 31 to 37 in 1bb7d91

install_requires=[
"Sphinx>=2",
"ipywidgets>=7.0.0",
"IPython",
"nbconvert>=5.5",
"nbformat",
],

bmwiedemann pushed a commit to bmwiedemann/openSUSE that referenced this pull request Aug 23, 2023
https://build.opensuse.org/request/show/1105444
by user bnavigator + anag+factory
- Add ipykernel to requirements
  * jupyter-sphinx-pr226-ipykernel.patch
  * gh#jupyter/jupyter-sphinx#226
- PEP517
@garrison
Copy link
Contributor Author

garrison commented Aug 30, 2023

You're editing the wrong file. The relevant dependency definition is in setup.py

Sorry, I erroneously assumed that this repository would obey DRY for this and therefore read requirements.txt from setup.py. Fixed.

@12rambau
Copy link
Contributor

note that it fixes #222

@bnavigator
Copy link

note that it fixes #222

The error message is not the same. Your issue was a missing ipykernel for python3, the reporter of #222 has a modified script intrepreter line (shebang) because of a non-standard test setup.

@mhvk
Copy link

mhvk commented Nov 22, 2023

It would be nice to get this in - I now added a dependence to ipykernel in my package, but ideally jupyter-sphinx should be enough.

p.s. Thanks for a really nice extension to sphinx!

@akhmerov akhmerov merged commit 6a47a75 into jupyter:master Dec 4, 2023
1 check failed
@garrison garrison deleted the direct-ipykernel-dependency branch May 21, 2024 14:06
garrison added a commit to Qiskit/qiskit-addon-cutting that referenced this pull request May 21, 2024
This is no longer necessary now that a release has been made
which includes jupyter/jupyter-sphinx#226.
garrison added a commit to Qiskit/qiskit-addon-cutting that referenced this pull request May 22, 2024
This is no longer necessary now that a release has been made
which includes jupyter/jupyter-sphinx#226.
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

Successfully merging this pull request may close these issues.

5 participants