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

Integrated Thebe Status & Launch Buttons #470

Closed
stevejpurves opened this issue Sep 1, 2021 · 4 comments
Closed

Integrated Thebe Status & Launch Buttons #470

stevejpurves opened this issue Sep 1, 2021 · 4 comments
Assignees
Projects

Comments

@stevejpurves
Copy link
Member

The Thebe repository provides examples in both rst (via it's docs) and html.

Within those examples, code is provided that allow users of the library to add their own status buttons and launch buttons.

Separately the sphinx-thebe library implements a status and launch button on top of dynamically loading thebe.

In a draft PR #459 I have taken a version of the kernel status widget from the examples and pulled it into the library, so it can be added to a page by adding a div tag with the expected class and supplying the config option.

We could do the same with a launch/activate button, meaning downstream users would not have to implement this.

questions:

  • Is there a case for adding a launch button?
  • Should we actually pull in the launch button from sphinx-thebe, and modify the latter to use that built in version?
@stevejpurves stevejpurves created this issue from a note in Activity Board (Needs Discussion 🗣) Sep 1, 2021
@choldgraf
Copy link
Member

choldgraf commented Sep 2, 2021

I think this is a cool idea - how would this work at the implementation level? Would the bootstrap just look for a few special DOM elements and, for the ones it find, process them to have the right hooks and such, and add some CSS?

(and happy to donate whatever we use in sphinx-thebe and then just consume that there)

@moorepants
Copy link
Collaborator

Having the status indicators be a default part of the interface is preferable. We had a fair amount of requests from users at Libretexts for more information about what was going on after "run" was pressed. Given that new images can take so long to load, it's really essential. We have a status indicator in the lower left and now that the little spinner is there from Steve's work, the users seem to have enough feedback. You can see ours here:

https://query.libretexts.org/Sandboxes/jupyterteam_at_ucdavis.edu

@stevejpurves
Copy link
Member Author

@moorepants yes I see it! that is nice and ys what it would be nice to provide out of the box.

@choldgraf yes, having DOM elements with special classes and thebe would "attach" new elements there, with minimal styling, giving the owner of the page ability to customize and style easily.

@stevejpurves stevejpurves moved this from Needs Discussion 🗣 to In progress ⚡ in Activity Board Oct 6, 2021
@stevejpurves stevejpurves self-assigned this Oct 6, 2021
@stevejpurves stevejpurves moved this from In progress ⚡ to Next Up 👍 in Activity Board Oct 18, 2021
@stevejpurves stevejpurves removed this from Next Up 👍 in Activity Board Oct 19, 2021
This was referenced Oct 19, 2021
@stevejpurves stevejpurves added this to Needs Discussion in General Oct 19, 2021
@stevejpurves
Copy link
Member Author

minimally styled status and activcate buttons are now in place

image

They are enabled/disabled by the following options:

{
   mountStatusWidget: true,
   mountActivateWidget: true,
   ...
}

General automation moved this from Needs Discussion to Merged Oct 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done 🎉
General
Merged
Development

No branches or pull requests

3 participants