matplotlib · agriyakhetarpal · Mar 10, 2022 · Jul 26, 2022 · Aug 5, 2022 · Aug 16, 2022
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -94,6 +94,16 @@ commands:
             python -m pip install --upgrade --user wheel
             python -m pip install --upgrade --user 'setuptools!=60.6.0'
 
+  mamba-install:
+    description: Install micromamba so it can be used for building the emscripten-forge environment
+    steps:
+      - run:
+          name: Install micromamba
+          command: |
+            curl -Ls https://micro.mamba.pm/api/micromamba/linux-64/latest | tar -xvj bin/micromamba
+            pwd
+            ls
+
   doc-deps-install:
     parameters:
       numpy_version:
@@ -138,6 +148,8 @@ commands:
       - run:
           name: Build documentation
           command: |
+            export PATH="$(pwd)/../bin:$PATH"
+            echo $PATH
             # Set epoch to date of latest tag.
             export SOURCE_DATE_EPOCH="$(git log -1 --format=%at $(git describe --abbrev=0))"
             # Set release mode only when deploying to devdocs.
@@ -228,6 +240,7 @@ jobs:
       - apt-install
       - fonts-install
       - pip-install
+      - mamba-install
 
       - doc-deps-install
       - mpl-install

diff --git a/.gitignore b/.gitignore
@@ -124,3 +124,7 @@ lib/matplotlib/backends/web_backend/node_modules/
 lib/matplotlib/backends/web_backend/package-lock.json
 
 LICENSE/LICENSE_QHULL
+
+# JupyterLite
+.jupyterlite.doit.db
+/doc/jupyterlite_contents
diff --git a/doc/Makefile b/doc/Makefile
@@ -28,6 +28,8 @@ clean:
 	rm -rf "$(SOURCEDIR)/sphinxext/__pycache__"
 	rm -f $(SOURCEDIR)/_static/constrained_layout*.png
 	rm -f $(SOURCEDIR)/sg_execution_times.rst
+	rm -rf $(SOURCEDIR)/jupyterlite_contents
+	rm -rf $(SOURCEDIR)/.jupyterlite.doit.db
 
 show:
 	@python -c "import webbrowser; webbrowser.open_new_tab('file://$(shell pwd)/build/html/index.html')"

diff --git a/doc/conf.py b/doc/conf.py
@@ -102,6 +102,16 @@ def _parse_skip_subdirs_file():
 # usage in the gallery.
 warnings.filterwarnings('error', append=True)
 
+# Prevent Sphinx-Gallery and jupytext incompatibility warning. This is spurious
+# and can be ignored for our use case. This has to be added before importing
+# jupyterlite_sphinx below, so that we can block the warning before it is raised.
+# TODO: Fix this in jupyterlite-sphinx
+# https://github.com/jupyterlite/jupyterlite-sphinx/issues/258
+warnings.filterwarnings('ignore', category=UserWarning,
+                        message=(
+                            r'(\n|.)*Sphinx Gallery in version 0.18.0 is not '
+                            r'supported by Jupytext'))
+
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
@@ -128,7 +138,7 @@ def _parse_skip_subdirs_file():
     'sphinxext.redirect_from',
     'sphinx_copybutton',
     'sphinx_design',
-    'sphinx_tags',
+    'jupyterlite_sphinx',
 ]
 
 exclude_patterns = [
@@ -305,6 +315,10 @@ def autodoc_process_bases(app, name, obj, options, bases):
     'within_subsection_order': gallery_order_subsectionorder,
     'capture_repr': (),
     'copyfile_regex': r'.*\.rst',
+    # Disable Sphinx-Gallery's JupyterLite integration until there's
+    # further notice. It comes from our usage of jupyterlite-sphinx
+    # as a registered extension.
+    'jupyterlite': None,
 }
 
 if parse_version(sphinx_gallery.__version__) >= parse_version('0.17.0'):
@@ -767,6 +781,23 @@ def js_tag_with_cache_busting(js):
      1),
 ]
 
+# JupyterLite config
+
+jupyterlite_bind_ipynb_suffix = False
+# Include the gallery examples in the JupyterLite deployment.
+# .zip,.png,.gif, .json and other extra file formats generated by
+# Sphinx-Gallery are ignored via the LiteBuildConfig/extra_ignore_contents
+# key in the jupyter_lite_config.json file.
+jupyterlite_contents = ["gallery/**"]
+# Set this to False to aid debugging locally or in CI. It is silenced
+# by default as there is no way to disable the JupyterLite output in
+# parts right now, and it can be quite verbose.
+jupyterlite_silence = False  # set to False when merging
+jupyterlite_build_command_options = {
+    "XeusAddon.environment_file": "jupyterlite_environment.yml",
+}
+
+
 # numpydoc config
 
 numpydoc_show_class_members = False

diff --git a/doc/index.rst b/doc/index.rst
@@ -99,6 +99,29 @@ Learn
                 - figures: `.pyplot.figure`
                 - subplots: `.pyplot.subplots`, `.pyplot.subplot_mosaic`
 
+Live example (experimental)
+===========================
+
+Try Matplotlib directly in this documentation (press :kbd:`shift` + :kbd:`Enter` to execute code)!
+
+.. rstcheck: ignore-directives=replite
+.. replite::
+   :kernel: xeus-python
+   :height: 600px
+   :prompt: Try Matplotlib!
+   :execute: False
+
+   %matplotlib inline
+
+   import matplotlib.pyplot as plt
+   import numpy as np
+
+   fig = plt.figure()
+   plt.plot(np.sin(np.linspace(0, 20, 100)))
+   plt.show();
+
+Alternatively, you can try the gallery examples in `our JupyterLite deployment <./lite/lab>`__.
+
 Community
 =========
 

diff --git a/doc/jupyter-lite.json b/doc/jupyter-lite.json
@@ -0,0 +1,10 @@
+{
+    "jupyter-lite-schema-version": 0,
+    "jupyter-config-data": {
+        "disabledExtensions": [
+          "@jupyterlite/javascript-kernel-extension",
+          "@jupyterlite/pyodide-kernel-extension"
+        ],
+        "contentsStorageName": "JupyterLite Matplotlib Docs Storage"
+    }
+}
diff --git a/doc/jupyter_lite_config.json b/doc/jupyter_lite_config.json
@@ -0,0 +1,7 @@
+{
+  "LiteBuildConfig": {
+    "extra_ignore_contents": ["\\.(rst|zip|pickle|py|json|svg|md5|png|gif)"],
+    "no_unused_shared_packages": true,
+    "no_sourcemaps": true
+  }
+}
diff --git a/doc/jupyterlite_environment.yml b/doc/jupyterlite_environment.yml
@@ -0,0 +1,18 @@
+# This environment file is added via the XeusAddon.environment_file
+# key in the jupyterlite_build_command_options dict in conf.py. See
+# https://jupyterlite-sphinx.readthedocs.io/en/stable/configuration.html
+# for more information on additional configuration options.
+---
+
+name: mpl-wasm-docs
+channels:
+  - https://repo.mamba.pm/emscripten-forge
+  - conda-forge
+dependencies:
+  # for examples in the gallery
+  # temporary: pin NumPy to <2 for now, see https://github.com/emscripten-forge/recipes/issues/1766
+  - numpy==1.26.4
+  - matplotlib
+  - ipympl
+  # a kernel for running them
+  - xeus-python
diff --git a/environment.yml b/environment.yml
@@ -43,6 +43,8 @@ dependencies:
   - joblib  # needed for sphinx-gallery[parallel]
   - sphinx-design
   - sphinx-tags>=0.4.0
+  - jupyterlite-sphinx>=0.18.0
+  - jupyterlite-xeus>=3.0.2
   - pystemmer
   - pip
   - pip:

diff --git a/requirements/doc/doc-requirements.txt b/requirements/doc/doc-requirements.txt
@@ -24,3 +24,5 @@ sphinx-copybutton
 sphinx-design
 sphinx-gallery[parallel]>=0.12.0
 sphinx-tags>=0.4.0
+jupyterlite-sphinx>=0.18.0
+jupyterlite-xeus>=3.0.2