Changelog #

Bugs fixed#

BUG: Fix SciPy make dist doc workflow by ensuring jupyter is run with the current Python executable #271 (@steppi)

Maintenance and upkeep improvements#

Documentation improvements#

Change button text contrast to comply with WCAG AA #269 (@mfisher87)

Contributors to this release#

@mfisher87 | @pre-commit-ci | @steppi

0.19.0#

Enhancements made#

Better mobile device detection for interactive examples buttons #250 (@agriyakhetarpal)

Bugs fixed#

BUG: Fix list of possible docstring section header patterns for global_enable_try_examples #263 (@steppi)
Add ConfigLoader with deduplicated logging and try_examples config caching #249 (@agriyakhetarpal)

Maintenance and upkeep improvements#

Update to actions/upload-artifact@v4 #267 (@jtpio)

Documentation improvements#

Update documentation around fullscreen usage of jupyterlite-sphinx apps #253 (@agriyakhetarpal)

Contributors to this release#

@agriyakhetarpal | @jtpio | @pre-commit-ci | @steppi

0.18.0#

Enhancements made#

Allow enabling/disabling REPL code execution in the Replite directive #245 (@agriyakhetarpal)

Bugs fixed#

Correctly handle case where “See Also” section follows “Examples” in global_enable_try_examples #251 (@agriyakhetarpal)

Maintenance and upkeep improvements#

Drop Python 3.8 #239 (@jtpio)
Relax jupyterlite-core and jupyterlite-xeus dependencies #238 (@jtpio)

Contributors to this release#

@agriyakhetarpal | @jtpio | @pre-commit-ci | @steppi

0.17.1#

Bugs fixed#

Add missing dependency on jupytext #236 (@agriyakhetarpal)

Contributors to this release#

@agriyakhetarpal

0.17.0#

Enhancements made#

Add a new-tabbed variant for the Replite directive, and allow customisation of its button text #228 (@agriyakhetarpal)
Allow global and custom button texts for the new-tabbed variants of the JupyterLite, NotebookLite, and the Voici directives #227 (@agriyakhetarpal)
Allow the use of a custom overrides.json file for configuring JupyterLite at runtime #225 (@agriyakhetarpal)
Add an option to open the Notebook UI and Voici apps in a new tab via theNotebookLite and Voici directives #223 (@agriyakhetarpal)
Support the usage of Markdown-based notebooks with “Lite” directives #221 (@agriyakhetarpal)

Bugs fixed#

Fix paths for Replite apps #224 (@agriyakhetarpal)

Maintenance and upkeep improvements#

Add some spacing below the Lite iframes #235 (@agriyakhetarpal)
Switch to Miniforge and drop Mambaforge #233 (@agriyakhetarpal)
Bump OS image and dependencies for Read the Docs build config #229 (@agriyakhetarpal)
Fix the opening of notebooks in a new tab when using the JupyterLite, NotebookLite, and Voici directives #220 (@agriyakhetarpal)

Contributors to this release#

@agriyakhetarpal | @pre-commit-ci | @steppi

0.16.5#

Bugs fixed#

Restore backwards compatibility with Sphinx <8 #201 (@agriyakhetarpal)

Contributors to this release#

@agriyakhetarpal

0.16.4#

Enhancements made#

Strip tagged cells from .ipynb notebooks passed to the NotebookLite and JupyterLite directives #180 (@agriyakhetarpal)
Pass additional configuration options to the jupyter lite build command #169 (@agriyakhetarpal)
Add the option to open JupyterLite window in new tab #165 (@melissawm)
Allow usage of global configuration values for TryExamples directive if provided by user #161 (@agriyakhetarpal)
Minor refactor + typing info #155 (@Carreau)
Give a pragmatic solution to suppressing noisy output #153 (@steppi)
Set lower default verbosity and add config options. #150 (@Carreau)
ENH: Add metadata for parallel_read_safe = True #148 (@steppi)
Add option for initial warning cell in try examples directive #143 (@steppi)
Hide buttons on smaller screens (mobile). #141 (@Carreau)
Suggestion: Add pre-commit to format js and css files. #137 (@Carreau)
Add a full screen “Open in tab” button #135 (@Carreau)
Add a loading spinner for TryExamples directive. #133 (@steppi)
Misc parsing warnings. #131 (@Carreau)
Improve TryExamples customization #129 (@steppi)
Add option to disable TryExamples without rebuilding docs #118 (@steppi)
Add more configuration options to TryExamples directive and add documentation #116 (@steppi)
Update to jupyterlite v0.2 #113 (@martinRenou)
Add try_examples directive for adding interactivity to sphinx Examples sections #111 (@steppi)

Bugs fixed#

Fix compatibility with Sphinx 8 #199 (@agriyakhetarpal)
Fix incorrect regex usage instructions for TryExamples JSON configuration file #194 (@agriyakhetarpal)
Restore SameFileError check when copying notebooks #190 (@melissawm)
Fix invalid schema for jupyterlite_sphinx_strip tag when strip_tagged_cells is True #189 (@agriyakhetarpal)
Resolve default-encoding errors on Windows #187 (@AA-Turner)
Hotfix: cell metadata to parse should be jupyterlite_sphinx_strip #185 (@agriyakhetarpal)
TryExamples directive: fix missing kernels in CircleCI deployments #182 (@agriyakhetarpal)
Issue 115 wrap fullscreen JupyterLite links #181 (@agriyakhetarpal)
Give a pragmatic solution to suppressing noisy output #153 (@steppi)
Add processing of literal blocks in try examples directive #134 (@steppi)

Maintenance and upkeep improvements#

Allow for JupyterLite 0.4.0 #193 (@jtpio)
Use the latest jupyterlite-xeus to fix the docs build #179 (@jtpio)
Update to jupyterlite-core >=0.2,<0.4 #160 (@jtpio)
Update releaser workflows #159 (@jtpio)
Raise informative error message when building man on older sphinx #158 (@Carreau)
Add ruff pre-commit and reformat files with it #156 (@Carreau)
Minor refactor + typing info #155 (@Carreau)
Run pre-commit on all files in this repository. #145 (@Carreau)
Update publish workflow to use the PyPI trusted publisher #123 (@jtpio)

Documentation improvements#

Issue 115 wrap fullscreen JupyterLite links #181 (@agriyakhetarpal)
Some general formatting fixes (punctuation, backticks, etc.) #172 (@agriyakhetarpal)
Fix incorrect math processing #139 (@steppi)
Update to jupyterlite-xeus #138 (@jtpio)
Improve TryExamples customization #129 (@steppi)

Contributors to this release#

0.16.3#

Maintenance and upkeep improvements#

Allow for JupyterLite 0.4.0 #193 (@jtpio)

Contributors to this release#

@jtpio | @pre-commit-ci

0.16.2#

Bugs fixed#

Restore SameFileError check when copying notebooks #190 (@melissawm)

Contributors to this release#

@melissawm

0.16.1#

Bugs fixed#

Fix invalid schema for jupyterlite_sphinx_strip tag when strip_tagged_cells is True #189 (@agriyakhetarpal)

Contributors to this release#

@agriyakhetarpal

0.16.0#

Enhancements made#

Strip tagged cells from .ipynb notebooks passed to the NotebookLite and JupyterLite directives #180 (@agriyakhetarpal)

Bugs fixed#

Resolve default-encoding errors on Windows #187 (@AA-Turner)
Hotfix: cell metadata to parse should be jupyterlite_sphinx_strip #185 (@agriyakhetarpal)
TryExamples directive: fix missing kernels in CircleCI deployments #182 (@agriyakhetarpal)
Issue 115 wrap fullscreen JupyterLite links #181 (@agriyakhetarpal)

Maintenance and upkeep improvements#

Use the latest jupyterlite-xeus to fix the docs build #179 (@jtpio)

Documentation improvements#

Issue 115 wrap fullscreen JupyterLite links #181 (@agriyakhetarpal)

Contributors to this release#

0.15.0#

Enhancements made#

Pass additional configuration options to the jupyter lite build command #169 (@agriyakhetarpal)
Add the option to open JupyterLite window in new tab #165 (@melissawm)

Maintenance and upkeep improvements#

Documentation improvements#

Some general formatting fixes (punctuation, backticks, etc.) #172 (@agriyakhetarpal)

Contributors to this release#

@agriyakhetarpal | @melissawm | @pre-commit-ci | @steppi

0.14.0#

Enhancements made#

Allow usage of global configuration values for TryExamples directive if provided by user #161 (@agriyakhetarpal)
Minor refactor + typing info #155 (@Carreau)

Maintenance and upkeep improvements#

Update to jupyterlite-core >=0.2,<0.4 #160 (@jtpio)
Update releaser workflows #159 (@jtpio)
Raise informative error message when building man on older sphinx #158 (@Carreau)
Add ruff pre-commit and reformat files with it #156 (@Carreau)
Minor refactor + typing info #155 (@Carreau)

Contributors to this release#

@agriyakhetarpal | @Carreau | @jtpio | @pre-commit-ci | @steppi

0.13.1#

Enhancements made#

Give a pragmatic solution to suppressing noisy output #153 (@steppi)

Bugs fixed#

Give a pragmatic solution to suppressing noisy output #153 (@steppi)

Contributors to this release#

@steppi

0.13.0#

Enhancements made#

Set lower default verbosity and add config options. #150 (@Carreau)
ENH: Add metadata for parallel_read_safe = True #148 (@steppi)

Maintenance and upkeep improvements#

Contributors to this release#

@Carreau | @pre-commit-ci | @steppi

0.12.0#

Enhancements made#

Add option for initial warning cell in try examples directive #143 (@steppi)
Hide buttons on smaller screens (mobile). #141 (@Carreau)
Suggestion: Add pre-commit to format js and css files. #137 (@Carreau)
Add a full screen “Open in tab” button #135 (@Carreau)
Add a loading spinner for TryExamples directive. #133 (@steppi)
Misc parsing warnings. #131 (@Carreau)
Improve TryExamples customization #129 (@steppi)
Add option to disable TryExamples without rebuilding docs #118 (@steppi)

Bugs fixed#

Add processing of literal blocks in try examples directive #134 (@steppi)

Maintenance and upkeep improvements#

Run pre-commit on all files in this repository. #145 (@Carreau)
Update publish workflow to use the PyPI trusted publisher #123 (@jtpio)

Documentation improvements#

Fix incorrect math processing #139 (@steppi)
Update to jupyterlite-xeus #138 (@jtpio)
Improve TryExamples customization #129 (@steppi)

Contributors to this release#

@Carreau | @jtpio | @martinRenou | @mattip | @steppi

0.11.0#

Enhancements made#

Add more configuration options to TryExamples directive and add documentation #116 (@steppi)

Contributors to this release#

@steppi

0.10.0#

Enhancements made#

Update to jupyterlite v0.2 #113 (@martinRenou)
Add try_examples directive for adding interactivity to sphinx Examples sections #111 (@steppi)

Contributors to this release#

@martinRenou | @steppi

0.9.3#

Bugs fixed#

Fix search params #109 (@brichet)

Contributors to this release#

@brichet

0.9.2#

Enhancements made#

Transfer search parameters from page URL to jupyterlite #108 (@brichet)

Contributors to this release#

@brichet | @martinRenou

0.9.1#

Bugs fixed#

Remove Apps config auto-computation #104 (@martinRenou)

Contributors to this release#

@martinRenou

0.9.0#

Enhancements made#

Add Voici directive #100 (@martinRenou)
Default lite directory to the docs directory #99 (@martinRenou)
Use xeus-python in docs #98 (@martinRenou)

Maintenance and upkeep improvements#

Update to jupyterlite-core==0.1.0, require Python 3.8 #96 (@jtpio)

Documentation improvements#

Add conda instructions and docs scripts #97 (@jtpio)
Update docs to mention adding other kernels #94 (@jtpio)
Add changelog to the docs, more markdown #93 (@jtpio)
Convert docs to Markdown #92 (@jtpio)
Add notice about jupyterlite-core in the changelog #91 (@jtpio)

Contributors to this release#

@jtpio | @martinRenou

0.8.0#

⚠️ jupyterlite-sphinx now depends on jupyterlite-core ⚠️

jupyterlite-sphinx now depends on the jupyterlite-core package instead of jupyterlite.

The jupyterlite-core package provides the core functionality for building JupyterLite websites, the CLI and extension points. Currently it only includes a JavaScript kernel that runs in Web Worker. If you would like to include a Python kernel in your deployment you will have to add it to your dependencies, for example with:

python -m pip install jupyterlite-pyodide-kernel

Or next to the jupyterlite-sphinx dependency:

jupyterlite-sphinx
jupyterlite-pyodide-kernel

Maintenance and upkeep improvements#

Depend on jupyterlite-core #89 (@jtpio)
Add releaser workflows and changelog #86 (@jtpio)

Contributors to this release#

@jtpio

0.7.3#

Documentation improvements#

Update the piplite_urls configuration #79 (@jtpio)

Other merged PRs#

Unpin sphinx #85 (@lesteve)
add a github link to the documentation #82 (@12rambau)
DOC fix broken link to custom Jupyterlite configuration #78 (@lesteve)

Contributors to this release#

@12rambau | @jtpio | @lesteve | @martinRenou

0.7.2#

Merged PRs#

Finish reverting config names. #74 (@jasongrout)
Restore jupyterlite_contents being optionally a string #73 (@jasongrout-db)

Contributors to this release#

@jasongrout | @jasongrout-db

0.7.1#

Merged PRs#

Make the jupyterlite_contents glob recursive. #72 (@jasongrout)

Contributors to this release#

@jasongrout

0.7.0#

Merged PRs#

“Try It Live!” button #67 (@martinRenou)
Make .ipynb source binding an opt-out #66 (@martinRenou)
add globbing to content #64 (@amueller)

Contributors to this release#

@12rambau | @amueller | @jtpio | @martinRenou

0.6.0#

Maintenance and upkeep improvements#

Remove unneeded code #60 (@jtpio)

Other merged PRs#

Revert renaming the config properties #62 (@martinRenou)

Contributors to this release#

@jtpio | @martinRenou

0.5.0#

Enhancements made#

More consistent naming #58 (@martinRenou)

Other merged PRs#

Update Pypi description to be the same as the readme #59 (@jasongrout)
Add jupyterlite_contents config #24 (@martinRenou)

Contributors to this release#

@jasongrout | @martinRenou

0.4.9#

Merged PRs#

Add jupyterlite_dir config option #16 (@martinRenou)

Contributors to this release#

@martinRenou

0.4.8#