Skip to content

Launch in jupyterlite #558

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

Closed
wants to merge 14 commits into from
Closed

Launch in jupyterlite #558

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
509fe48
First attempt at "Launch in RetroLite"
psychemedia Mar 14, 2022
50b5efe
Merge branch 'executablebooks:master' into launch-in-jupyterlite
psychemedia Mar 19, 2022
da387dd
Merge branch 'executablebooks:master' into launch-in-jupyterlite
psychemedia Apr 20, 2022
090bd57
Merge branch 'executablebooks:master' into launch-in-jupyterlite
psychemedia May 4, 2022
4d06814
Update jupyterlite icon
psychemedia May 4, 2022
b2fa323
Update jupyterlite launcher docs
psychemedia May 4, 2022
fa021a1
Merge branch 'executablebooks:master' into launch-in-jupyterlite
psychemedia May 10, 2022
4b051fb
Merge branch 'master' into launch-in-jupyterlite
psychemedia Jun 14, 2022
47d8875
Use absolute URL without domain for retrolite
yuvipanda Jun 27, 2022
e8dcd94
Merge pull request #3 from yuvipanda/launch-in-jupyterlite
yuvipanda Jun 28, 2022
bd30377
incorporate @choldgraf's changes
ivanov Jul 1, 2022
61e047d
Merge branch 'master' into launch-in-jupyterlite
ivanov Jul 1, 2022
bf9f136
Merge branch 'master' into launch-in-jupyterlite
psychemedia Aug 2, 2022
d50aac6
Merge branch 'master' into launch-in-jupyterlite
psychemedia Aug 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@
"binderhub_url": "https://mybinder.org",
"colab_url": "https://colab.research.google.com/",
"deepnote_url": "https://deepnote.com/",
"retrolite_url": "./lite/retro/notebooks/",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we call this jupyterlite_url for now, since that is the "parent" tool, and document how to make it connect w/ retro vs. lab etc in the text below?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My thinking was separate URLs for whether the launch was into retrolab or open notebook in jupyterlab/jupyterlite

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I opened an issue some time ago in jupyterlite repo wrt to having a discrete *lite identities for these two UIs, motivated in part by this PR: jupyterlite/jupyterlite#549

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think where we're heading for the launch button config is to provide a list of configuration snippets that each map onto one button, so I'd imagine this will eventually look like:

"launch_buttons": [
    {"type": "jupyterlite", "root": "/lite", "prefix": "/lab", "name": "Launch JupyterLite"},
    {"type": "jupyterlite", "root": "/lite", "prefix": "/retro", "name": "Launch RetroLite"},
    {"type": "jupyterhub", "url": "https://hub1.myorg.org", "name": "Launch JupyterHub One"},
    {"type": "jupyterhub", "url": "https://hub2.myorg.org", "name": "Launch JupyterHub Two"},
]

So that's why I was thinking we'd just have one name for it, does that make sense or do you think it would make more sense to use type: "jupyterlite" and type: "retrolite"?

"notebook_interface": "jupyterlab",
"thebe": True,
# "jupyterhub_url": "https://datahub.berkeley.edu", # For testing
Expand Down
21 changes: 21 additions & 0 deletions docs/launch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,27 @@ html_theme_options = {
This will create a new Deepnote project every time you click the launch button.
```

## RetroLite

To add [RetroLite](https://jupyterlite-sphinx.readthedocs.io/en/latest/retrolite.html) links to your page, add the following configuration:

```python
html_theme_options = {
...
"launch_buttons": {
"retrolite_url": "./lite/retro/notebooks/"
},
...
}
```

```{warning}
This requires installation of [`jupyterlite-sphinx`](https://jupyterlite-sphinx.readthedocs.io/) and the publication of a RetroLite environment as part of your published Jupyter Book environment.

You __must__ also publish the Jupyter Book / JupyterLite environemt via a webserver in order to access the JupyterLite environment.

*As of `jupyterlite-sphinx==0.4.7, you will have to manually ensure that notenook files are copied over to the `_build/html/lite/files` directory in order to work with them in JupyterLite.*
```
Copy link
Member

@choldgraf choldgraf Jun 28, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## RetroLite
To add [RetroLite](https://jupyterlite-sphinx.readthedocs.io/en/latest/retrolite.html) links to your page, add the following configuration:
```python
html_theme_options = {
...
"launch_buttons": {
"retrolite_url": "./lite/retro/notebooks/"
},
...
}
```
```{warning}
This requires installation of [`jupyterlite-sphinx`](https://jupyterlite-sphinx.readthedocs.io/) and the publication of a RetroLite environment as part of your published Jupyter Book environment.
You __must__ also publish the Jupyter Book / JupyterLite environemt via a webserver in order to access the JupyterLite environment.
*As of `jupyterlite-sphinx==0.4.7, you will have to manually ensure that notenook files are copied over to the `_build/html/lite/files` directory in order to work with them in JupyterLite.*
```
## JupyterLite and RetroLite
```{warning}
JupyterLite and RetroLite are experimental, and their behavior and configuration may change over time!
Please provide feedback and suggestions.
```
[JupyterLite](https://jupyterlite.readthedocs.io/) allows you to run a Jupyter environment entirely in the browser via [WebAssembly](https://webassembly.org/) and [Pyodide](https://pyodide.org/en/stable/).
To use JupyterLite in your launch buttons, you'll first need to take these steps:
1. **Install [`jupyterlite-sphinx`](https://jupyterlite-sphinx.readthedocs.io/)**. And configure it to publish a JupyterLab environment as part of your published Jupyter Book environment by [following the installation instructions](https://jupyterlite-sphinx.readthedocs.io/en/latest/installation.html).
2. **Configure JupyterLite Sphinx to use your site content as a folder**. You can configure JupyterLite Sphinx to look for notebooks in a specified directory. Put the notebooks you wish to expose in that directory, and [follow these configuration instructions](https://jupyterlite-sphinx.readthedocs.io/en/latest/configuration.html#jupyterlite-content).
```
There are two different interfaces that you can activate with JupyterLite, each is described below.
### JupyterLab via JupyterLite
To add JupyterLab via JupyterLite to your launch buttons, use the following configuration:
```python
html_theme_options = {
...
"launch_buttons": {
"jupyterlite_url": "/lite/lab/notebooks/"
},
...
}
```
Where `notebooks/` is a folder with a collection of Jupyter Notebooks you'd like to serve with JupyterLite.
### RetroLab via JupyterLite
RetroLab mimics the classic Jupyter Notebook interface, but using JupyterLab components.
It will be the default Notebook interface in the near future.
To add RetroLab via JupyterLite to your launch buttons, use the following configuration:
```python
html_theme_options = {
...
"launch_buttons": {
"jupyterlite_url": "/lite/retro/notebooks/"
},
...
}
```

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some suggestions to flesh this out a bit more, since most people won't know how to use JupyterLite or what it is

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the URL should be absolute (/lite/retro/notebooks/, without the . prefix) for it to work. This was fixed in my PR


## Live code cells with Thebe

Expand Down
13 changes: 13 additions & 0 deletions src/sphinx_book_theme/header_buttons/launch.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ def add_launch_buttons(
binderhub_url = launch_buttons.get("binderhub_url", "").strip("/")
colab_url = launch_buttons.get("colab_url", "").strip("/")
deepnote_url = launch_buttons.get("deepnote_url", "").strip("/")
retrolite_url = launch_buttons.get("retrolite_url", "").strip("/")
if binderhub_url:
url = (
f"{binderhub_url}/v2/gh/{org}/{repo}/{branch}?"
Expand Down Expand Up @@ -161,6 +162,18 @@ def add_launch_buttons(
}
)

if retrolite_url:
url = f"{retrolite_url}?path={path_rel_repo}"
launch_buttons_list.append(
{
"type": "link",
"text": "RetroLite",
"tooltip": "Launch via RetroLite",
"icon": "_static/images/logo_jupyterlite.svg",
"url": url,
}
)

# Add thebe flag in context
if launch_buttons.get("thebe", False):
launch_buttons_list.append(
Expand Down
17 changes: 17 additions & 0 deletions src/sphinx_book_theme/theme/sphinx_book_theme/static/images/logo_jupyterlite.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions tests/sites/base/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
"jupyterhub_url": "https://datahub.berkeley.edu",
"colab_url": "https://colab.research.google.com",
"deepnote_url": "https://deepnote.com",
"retrolite_url": "./lite/retro/notebooks/",
"notebook_interface": "jupyterlab",
"thebe": True,
},
Expand Down