8000 JupyterLite in documenation by DerThorsten · Pull Request #6500 · scikit-image/scikit-image · GitHub
[go: up one dir, main page]
Skip to content

JupyterLite in documenation #6500

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 4 commits into from
Closed

JupyterLite in documenation #6500

wants to merge 4 commits into from

Conversation

DerThorsten
Copy link
@DerThorsten DerThorsten commented Aug 30, 2022 •
edited
Loading

Description

This adds a jupyterlite shell to the documentation which can be tried out on the fly.

Locally this already works fine, maybe it will also work on the CI already.
Atm I put the jupyterlite console at the very beginning of the documentation (probably should be in some subsection)

If you are interested in this I can polish this PR more!

A few thoughts:

try_me
code

8000

@DerThorsten DerThorsten marked this pull request as draft August 30, 2022 13:56
@DerThorsten DerThorsten changed the title wip JupyterLite in documenation Aug 30, 2022
@pep8speaks
Copy link
pep8speaks commented Aug 31, 2022 •
edited
Loading

Hello @DerThorsten! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2022-08-31 07:55:34 UTC

@DerThorsten DerThorsten marked this pull request as ready for review August 31, 2022 07:55
@lagru lagru added 📄 type: Documentation Updates, fixes and additions to documentation 👶 type: New feature labels Sep 2, 2022
@lagru
Copy link
Member
lagru commented Sep 2, 2022

Thanks @DerThorsten! I'll try it out it the next few days. :)

@emmanuelle
Copy link
Member

Thank you @DerThorsten ! I also need to read the PR in more details. Right now you can take a look at the built CI doc on https://output.circle-artifacts.com/output/job/60034042-2f07-4163-96d7-57e0b56af094/artifacts/0/doc/build/html/index.html

Taking a look at the CI doc, it looks like the output is not displayed (see screenshot below), I guess this is not what is expected?

Screenshot from 2022-09-02 23-10-54

@mkcor
Copy link
Member
mkcor commented Sep 6, 2022

Exciting! Thanks for your submission, @DerThorsten.

From the Medium post by @jtpio and @martinRenou:

The NumPy project had already been using an interactive console on the numpy.org documentation website.

I was curious of what happened with this interactive console, so here I am 🙂

we could reuse existing demo notebooks

Oh, yes!

@DerThorsten
Copy link
Author

Thank you @DerThorsten ! I also need to read the PR in more details. Right now you can take a look at the built CI doc on https://output.circle-artifacts.com/output/job/60034042-2f07-4163-96d7-57e0b56af094/artifacts/0/doc/build/html/index.html

I can't load this at all from the circleci artifacts. The page is very slow and most downloads timeout so the repl does not event start this way.

Taking a look at the CI doc, it looks like the output is not displayed (see screenshot below), I guess this is not what is expected?

This is not expected and I hope this is just some issue when loading the page from the circleci artifacts

with my local build it looks like this:

skimage

@lagru
Copy link
Member
lagru commented Sep 6, 2022 •
edited
Loading

Okay, I have several thoughts on this:

  • I think there is value in providing a quick and low barrier way to explore and play around with scikit-image a little bit. But only if it does not significantly complicate our CI or maintenance burden. 😉
  • From what I gathered during the conference, JupyterLite does not support downloading datasets via pooch because it's not allowed sockets? I think our gallery examples rely on that.
  • I'm not that keen about adding this to our gallery as we already using MyBinder which has been low maintenance for scikit-image (correct me if I'm wrong).
  • Emulating NumPy, I think a good place for this could be https://scikit-image.org rather than our Sphinx doc at https://scikit-image.org/docs/stable/.

Thinking about this, I'm really wondering if other projects already have statistics about user interaction with JupyterLite (e.g. NumPy's start page) and MyBinder.

Btw, this is #6500! 🥳

@stefanv
Copy link
Member
stefanv commented Sep 13, 2022

I think this is the kind of widget that works well on a project frontpage, like what NumPy does.

For our documentation, I suggest we work on using JupyterLite to make our gallery pages interactive, very much like we do with Binder.

@mkcor mkcor mentioned this pull request Sep 19, 2022
Closed
@stefanv
Copy link
Member
stefanv commented Oct 18, 2022

I'm going to close this in preference of future work done on Sphinx integrations with pyodide. See, e.g., https://blog.holoviz.org/panel_0.14.html#Sphinx-extension

Thank you for opening this investigation, @DerThorsten!

@stefanv stefanv closed this Oct 18, 2022
@lesteve
Copy link
Contributor
lesteve commented Apr 27, 2023

FYI I have opened #6911 that uses sphinx-gallery JupyterLite integration to add a JupyterLite button to each example similarly to what was done in scikit-learn.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
👶 type: New feature 📄 type: Documentation Updates, fixes and additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@DerThorsten @pep8speaks @lagru @emmanuelle @mkcor @stefanv @lesteve
0