search

executablebooks / sphinx-thebe

A Sphinx extension to convert static code into interactive code cells with Jupyter, Thebe, and Binder.
https://sphinx-thebe.readthedocs.io/en/latest/
MIT License
28 stars 15 forks source link

Change config option name to correctly select kernel #59

Closed joergbrech closed 1 year ago

joergbrech commented 1 year ago

Describe the bug

context

I have a jupyter-book using octave notebooks. Live-Code with thebe stopped working after updating jb to 0.13.1.

expectation.

Running live-code with thebe should work out of the box with an octave kernel, but it doesn't. Running the jupyter notebooks in mybinder.org works as expected.

bug

This seems to be caused by https://github.com/executablebooks/thebe/issues/349. If I understand correctly, thebe >= 0.6.0 requires the kernel to be set via kernelOptions.name rather than kernelOptions.kernalName. I verified this by manually adding kernelOptions.name to a locally built html file.

possible fix

After a first glance at sphinx-thebe, I suppose it could suffice to fix this line:

https://github.com/executablebooks/sphinx-thebe/blob/d9c1f3db9a65146319c15bdc7d4e91d25c58f23e/sphinx_thebe/__init__.py#L148

Reproduce the bug

As a consequence, the sphinx-thebe documentation is currently broken: Running the interactive R code on https://sphinx-thebe.readthedocs.io/en/latest/configure.html does not work.

List your environment

jupyter-book version 0.13.1

welcome[bot] commented 1 year ago

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada: