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

Consider using sphinx-thebelab for thebelab support #137

Open
choldgraf opened this issue Jul 3, 2020 · 2 comments
Open

Consider using sphinx-thebelab for thebelab support #137

choldgraf opened this issue Jul 3, 2020 · 2 comments
Milestone

Comments

@choldgraf
Copy link
Contributor

Now that sphinx-thebelab (https://github.com/executablebooks/sphinx-thebelab) is starting to take shape, I wonder what folks think about using it for thebelab support in jupyter-sphinx. It should be possible to use it out-of-the box and remove a good chunk of code from jupyter-sphinx. If folks are interested in this, I can give it a shot when it's the right time to try it.

@akhmerov
Copy link
Member

akhmerov commented Jul 3, 2020

Absolutely! Would be awesome!

@akhmerov
Copy link
Member

akhmerov commented Jan 2, 2021

I'm now returning to this issue. @choldgraf I'd be very interested to hear your thoughts on the following aspects of the implementation.

User interface

  1. I imagine jupyter-sphinx will silently include sphinx-thebelab, but only enable it and add assets if it's configured. Does this make sense?
  2. What about thebe configuration: for backwards compatibility it makes sense to still support it as provided by jupyter-sphinx, however moving forward would it make sense to use the sphinx-thebe configuration keys in conf.py?

Implementation

sphinx-thebe determines the kernel from the document metadata, while jupyter-sphinx allows for multiple notebooks/kernels in one document. This is of course something that we can only partially support anyway, so it would make sense if the kernel of the first notebook encountered in the document is added to the metadata. Does that make sense?

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

No branches or pull requests

2 participants