Mar 10, 2022 · Jul 26, 2022 · Aug 5, 2022 · Aug 16, 2022 · Jan 16, 2025 · Jan 16, 2025
diff --git a/.circleci/config.yml b/.circleci/config.yml
            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:
      - 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.
      - apt-install
      - fonts-install
      - pip-install
      - mamba-install

      - doc-deps-install
      - mpl-install
diff --git a/.gitignore b/.gitignore
 lib/matplotlib/backends/web_backend/package-lock.json

 LICENSE/LICENSE_QHULL

 # JupyterLite
 .jupyterlite.doit.db
 /doc/jupyterlite_contents
diff --git a/.yamllint.yml b/.yamllint.yml
 ---
 extends:default

 ignore:|
  doc/jupyterlite_environment.yml

 rules:
 line-length:
 max:120
diff --git a/doc/Makefile b/doc/Makefile
 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
 # 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
 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 = [
    'sphinxext.redirect_from',
    'sphinx_copybutton',
    'sphinx_design',
    'sphinx_tags',
    'jupyterlite_sphinx',
 ]

 exclude_patterns = [
    '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'):
     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 = True
 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
                - 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
 {
    "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
 {
 "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
 # 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
  - numpy
  - matplotlib
  - ipympl
  # a kernel for running them
  - xeus-python
diff --git a/environment.yml b/environment.yml
  - 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
 sphinx-design
 sphinx-gallery[parallel]>=0.12.0
 sphinx-tags>=0.4.0
 jupyterlite-sphinx>=0.18.0
 jupyterlite-xeus>=3.0.2
Original file line number	Diff line number	Diff line change
Expand Up		@@ -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:
Expand DownExpand Up		@@ -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.
Expand DownExpand Up		@@ -228,6 +240,7 @@ jobs:
		- apt-install
		- fonts-install
		- pip-install
		- mamba-install

		- doc-deps-install
		- mpl-install
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -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
Original file line number	Diff line number	Diff line change
		@@ -1,6 +1,9 @@
		---
		extends:default

		ignore:\|
		doc/jupyterlite_environment.yml

agriyakhetarpal marked this conversation as resolved. OutdatedShow resolvedHide resolved
		rules:
		line-length:
		max:120
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -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')"
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -102,6 +102,15 @@ 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
agriyakhetarpal marked this conversation as resolved. Show resolvedHide resolved
		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 = [
Expand All		@@ -128,7 +137,7 @@ def _parse_skip_subdirs_file():
		'sphinxext.redirect_from',
		'sphinx_copybutton',
		'sphinx_design',
		'sphinx_tags',
		'jupyterlite_sphinx',
		]

		exclude_patterns = [
Expand DownExpand Up		@@ -305,6 +314,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'):
Expand DownExpand Up		@@ -767,6 +780,23 @@ def js_tag_with_cache_busting(js):
		1),
		]

		# JupyterLite config
Copy link Member QuLogicJan 24, 2025 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. Is there a way this can be disabled by default and enabled by a flag? This could be set on CI and in release mode. I'm not sure we want to be paying the build costs locally for every developer. But since the build failed, I'm not sure exactly how large that build time cost is, so itcould be negligible for all I know. Copy link Author agriyakhetarpalJan 24, 2025• edited Loading Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. The build time cost is around ~15 seconds for me locally, which seems negligible in comparison to the rest of the docs build – I've been building with`html-noplot` at this time, so it would even lesser of a fraction with CI builds which would be longer. But to answer whether this can be disabled, I can check for the`DEVDOCS` and`is_release_build` constants so that this is avoided on local builds, as this concern was also raised from the perspective of downstream packagers in the older PR#22634. It could make debugging a build that's failing in CI a bit of a pain, though. Copy link Member QuLogicJan 24, 2025 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. Well, let's see how long it ends up taking first.

		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 = True
		jupyterlite_build_command_options = {
		"XeusAddon.environment_file": "jupyterlite_environment.yml",
		}


		# numpydoc config

		numpydoc_show_class_members = False
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -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
		=========

Expand Down
Original file line number	Diff line number	Diff line change
		@@ -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"
		}
		}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,7 @@
		{
Copy link Member QuLogicJan 24, 2025 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. Copy link Member martinRenouJan 24, 2025 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. Copy link jtpioJan 24, 2025 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": {
		"extra_ignore_contents": ["\\.(rst\|zip\|pickle\|py\|json\|svg\|md5\|png\|gif)"],
		"no_unused_shared_packages":true,
		"no_sourcemaps":true
		}
		}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,15 @@
		# 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
		- numpy
		- matplotlib
		- ipympl
		# a kernel for running them
		- xeus-python
Original file line number	Diff line number	Diff line change
Expand Up		@@ -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:
Expand Down