Skip to content

DOC: Add a JupyterLite-powered REPL to the Matplotlib documentation's landing page, and enable interactive galleries #29506

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

Draft
agriyakhetarpal wants to merge 37 commits into
base: main
Choose a base branch
from
Draft

DOC: Add a JupyterLite-powered REPL to the Matplotlib documentation's landing page, and enable interactive galleries #29506

Changes from 1 commit
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
fae43c3
Add replite console to the users docs
martinRenou Mar 10, 2022
e5ecaac
Update gallery and add link to the JupyterLite deployment
martinRenou Jul 26, 2022
2374f55
Use latest jupyterlite-xeus-python
martinRenou Aug 5, 2022
7c75115
Use recursive glob for the content
martinRenou Aug 16, 2022
c92ca21
JupyterLite dependencies now available with conda-forge
agriyakhetarpal Jan 16, 2025
47b4b42
Move gallery sentence below the REPL iframe
agriyakhetarpal Jan 16, 2025
251ab4b
Disable Pyodide kernel, Xeus is already configured
agriyakhetarpal Jan 21, 2025
5194b89
Disable `rstcheck` for Replite directive
agriyakhetarpal Jan 21, 2025
7c7dce7
Ignore unintended Jupytext/Sphinx-Gallery warning
agriyakhetarpal Jan 21, 2025
9786561
Ignore JupyterLite contents and doit file
agriyakhetarpal Jan 21, 2025
ede0d71
Remove JupyterLite contents with `make clean`
agriyakhetarpal Jan 21, 2025
0faaf52
Add missing environment, fix JupyterLite builds
agriyakhetarpal Jan 21, 2025
5ebdd52
Fix the REPL's size and formatting
agriyakhetarpal Jan 21, 2025
a26fbf3
Disable Sphinx-Gallery's JupyterLite integration for now
agriyakhetarpal Jan 21, 2025
2ccd369
Drop `XeusPythonEnv` for env file, add WASM deps
agriyakhetarpal Jan 22, 2025
3601e38
Optimise JupyterLite for build size
agriyakhetarpal Jan 22, 2025
3e08f5f
Add note about Xeus environment file
agriyakhetarpal Jan 22, 2025
f74bec7
Fix: incorrect kernel name
agriyakhetarpal Jan 22, 2025
5422940
Use `kbd` directive for highlighting keys
agriyakhetarpal Jan 22, 2025
22ce559
Mark live example as "experimental"
agriyakhetarpal Jan 23, 2025
34611e1
Add gallery contents to JupyterLite deployment
agriyakhetarpal Jan 23, 2025
c170ede
Missing kernel, add xeus-python
agriyakhetarpal Jan 23, 2025
3078611
Add custom storage name
agriyakhetarpal Jan 23, 2025
5ec29f3
Properly ignore extra contents
agriyakhetarpal Jan 23, 2025
759f78c
Silence JupyterLite now that we're done
agriyakhetarpal Jan 23, 2025
4fed028
Debug: un-silence JupyterLite build
agriyakhetarpal Jan 23, 2025
d8d63da
Pin NumPy to <2
agriyakhetarpal Jan 23, 2025
cf3a737
Reminder for silencing JupyterLite
agriyakhetarpal Jan 23, 2025
3faa465
Move the REPL to Gallery intro page
agriyakhetarpal Jan 23, 2025
451ae62
Don't ignore JupyterLite env file from linting
agriyakhetarpal Jan 24, 2025
86a5f7c
Link to Jupytext-related jupyterlite-sphinx issue
agriyakhetarpal Jan 24, 2025
55fe769
Don't update MEP-12
agriyakhetarpal Jan 24, 2025
f0d4de4
Remove REPL from galleries page
agriyakhetarpal Jan 24, 2025
6ad6e46
Try installing `pip` packages into a venv
agriyakhetarpal Jan 24, 2025
94e4246
Activate venv before docs build
agriyakhetarpal Jan 24, 2025
260d3d7
Revert "Activate venv before docs build"
agriyakhetarpal Jan 27, 2025
a60b9d0
Revert "Try installing `pip` packages into a venv"
agriyakhetarpal Jan 27, 2025
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
Prev Previous commit
Next Next commit
Properly ignore extra contents
  • Loading branch information
@agriyakhetarpal
agriyakhetarpal committed Jan 23, 2025
commit 5ec29f38d4902c569b38b5abfb0aa6a48d11d107
2 changes: 1 addition & 1 deletion doc/jupyter_lite_config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{

@QuLogic QuLogic Jan 24, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Why is there a jupyter-lite.json and jupyter_lite_config.json? These seem redundantly (or at least non-descriptively) named.

@martinRenou martinRenou Jan 24, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I've always been confused about this myself. One is for the CLI, one is for the JupyterLite frontend. The naming is pretty bad.

@jtpio jtpio Jan 24, 2025

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The JupyterLite CLI is a traitlets based app, so jupyter_lite_config.json follows the naming convention as other apps, like voila.json or jupyter_server_config.json. It is indeed for build time configuration (when running the JupyterLite CLI, for example with jupyter lite build).

jupyter-lite.json is for runtime configuration when loading the page. It is similar to the page_config.json used in JupyterLab.

Agree this can be confusing. Maybe JupyterLite could also support loading page_config.json files so users could choose a different name for the file?

For more information: https://jupyterlite.readthedocs.io/en/stable/howto/configure/config_files.html

"LiteBuildConfig": {
"ignore_contents": ["\\.(rst|zip|pickle|py|md5|png|gif)"],
"extra_ignore_contents": ["\\.(rst|zip|pickle|py|json|svg|md5|png|gif)"],
"no_unused_shared_packages": true,
"no_sourcemaps": true
}
Expand Down