CHANGELOG.md

Changelog

0.23.0

(Full Changelog)

Enhancements made

• allow configuring the path of the contents directory #346 (@keewis, @agriyakhetarpal, @martinRenou)
• Un-flatten JupyterLite contents: preserve notebook paths and directory structure #337 (@agriyakhetarpal, @martinRenou)
• run jupyter lite build with check=False #332 (@keewis, @agriyakhetarpal)
• Add more REPL customisation features for JupyterLite 0.6.0 and later #290 (@agriyakhetarpal, @jtpio, @martinRenou)

Bugs fixed

• Fix overflow for JupyterLite iframes when added by directives used inside PST admonitions #333 (@agriyakhetarpal, @martinRenou)

Maintenance and upkeep improvements

• Allow for JupyterLite 0.8.0 #348 (@jtpio, @agriyakhetarpal)
• Unpin jupyterlite-xeus in docs dependency group and use latest micromamba for docs builds #339 (@agriyakhetarpal, @martinRenou)
• Make jupytext an optional dependency #336 (@agriyakhetarpal, @martinRenou, @mfisher87)
• Use dependency groups instead of optional dependencies #335 (@agriyakhetarpal, @mfisher87)
• Drop support for Python 3.9 #334 (@agriyakhetarpal, @mfisher87)

Documentation improvements

• Update to latest emscripten-forge #349 (@martinRenou)

Contributors to this release

The following people contributed discussions, new ideas, code and documentation contributions, and review. See our definition of contributors.

(GitHub contributors page for this release)

@agriyakhetarpal (activity) | @jtpio (activity) | @keewis (activity) | @martinRenou (activity) | @mfisher87 (activity)

0.22.1

(Full Changelog)

Enhancements made

• allow adding a preamble for try_examples #293 (@keewis, @martinRenou)

Maintenance and upkeep improvements

• Reduce pre-commit autoupdate frequency to monthly #322 (@mfisher87, @Carreau)

Documentation improvements

• DOC: Change heading level for configuration bullet. #325 (@rossbar, @martinRenou)

Contributors to this release

The following people contributed discussions, new ideas, code and documentation contributions, and review. See our definition of contributors.

(GitHub contributors page for this release)

@agriyakhetarpal (activity) | @Carreau (activity) | @keewis (activity) | @martinRenou (activity) | @mfisher87 (activity) | @rossbar (activity)

0.22.0

(Full Changelog)

Enhancements made

• replite: Support :showBanner: 0 #317 (@chrysn)

Maintenance and upkeep improvements

• Bump jupyterlite-core dependency #318 (@chrysn)

Documentation improvements

• doc: Explain repl's kernel parameter, fix value to avoid dialog #316 (@chrysn)

Contributors to this release

(GitHub contributors page for this release)

@chrysn | @pre-commit-ci

0.21.0

(Full Changelog)

Enhancements made

• Add jupyterlite_ignore_contents config, mapping to --ignore-contents arg in JupyterLite build #309 (@mfisher87)

Maintenance and upkeep improvements

• Run black at pre-commit time #311 (@mfisher87)
• Gitignore node_modules/ #310 (@mfisher87)

Contributors to this release

(GitHub contributors page for this release)

@mfisher87 | @pre-commit-ci

0.20.2

(Full Changelog)

Enhancements made

• Bump jupyterlite-core dependency #299 (@martinRenou)

Maintenance and upkeep improvements

Contributors to this release

(GitHub contributors page for this release)

@martinRenou | @pre-commit-ci

0.20.1

(Full Changelog)

Bugs fixed

• Fix IndexErrors when the "Examples" is the last section in a docstring #292 (@agriyakhetarpal)

Maintenance and upkeep improvements

Contributors to this release

(GitHub contributors page for this release)

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

0.20.0

(Full Changelog)

Enhancements made

• Allow adding contents from outside the Sphinx source directory #280 (@agriyakhetarpal)
• Fix try button and shadows for dark theme #279 (@IsabelParedes)

Bugs fixed

• Fix incorrect disable marker for TryExamples buttons #284 (@agriyakhetarpal)

Maintenance and upkeep improvements

• pin micromamba to v2.0.5 to fix failing RTD builds #277 (@agriyakhetarpal)

Contributors to this release

(GitHub contributors page for this release)

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

0.19.1

(Full 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

(GitHub contributors page for this release)

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

0.19.0

(Full Changelog)

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

(GitHub contributors page for this release)

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

0.18.0

(Full Changelog)

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

(GitHub contributors page for this release)

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

0.17.1

(Full Changelog)

Bugs fixed

• Add missing dependency on jupytext #236 (@agriyakhetarpal)

Contributors to this release

(GitHub contributors page for this release)

@agriyakhetarpal

0.17.0

(Full Changelog)

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

(GitHub contributors page for this release)

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

0.16.5

(Full Changelog)

Bugs fixed

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

Contributors to this release

(GitHub contributors page for this release)

@agriyakhetarpal

0.16.4

(Full Changelog)

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

(GitHub contributors page for this release)

@AA-Turner | @agriyakhetarpal | @Carreau | @jtpio | @martinRenou | @matthewfeickert | @mattip | @melissawm | @pre-commit-ci | @steppi | @WarrenWeckesser

0.16.3

(Full Changelog)

Maintenance and upkeep improvements

• Allow for JupyterLite 0.4.0 #193 (@jtpio)

Contributors to this release

(GitHub contributors page for this release)

@jtpio | @pre-commit-ci

0.16.2

(Full Changelog)

Bugs fixed

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

Contributors to this release

(GitHub contributors page for this release)

@melissawm

0.16.1

(Full Changelog)

Bugs fixed

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

Contributors to this release

(GitHub contributors page for this release)

@agriyakhetarpal

0.16.0

(Full Changelog)

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

(GitHub contributors page for this release)

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

0.15.0

(Full Changelog)

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

(GitHub contributors page for this release)

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

0.14.0

(Full Changelog)

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

(GitHub contributors page for this release)

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

0.13.1

(Full Changelog)

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

(GitHub contributors page for this release)

@steppi

0.13.0

(Full Changelog)

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

(GitHub contributors page for this release)

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

0.12.0

(Full Changelog)

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

(GitHub contributors page for this release)

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

0.11.0

(Full Changelog)

Enhancements made

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

Contributors to this release

(GitHub contributors page for this release)

@steppi

0.10.0

(Full Changelog)

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

(GitHub contributors page for this release)

@martinRenou | @steppi

0.9.3

(Full Changelog)

Bugs fixed

• Fix search params #109 (@brichet)

Contributors to this release

(GitHub contributors page for this release)

@brichet

0.9.2

(Full Changelog)

Enhancements made

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

Contributors to this release

(GitHub contributors page for this release)

@brichet | @martinRenou

0.9.1

(Full Changelog)

Bugs fixed

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

Contributors to this release

(GitHub contributors page for this release)

@martinRenou

0.9.0

(Full Changelog)

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

(GitHub contributors page for this release)

@jtpio | @martinRenou

0.8.0

(Full Changelog)

⚠️ 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

(GitHub contributors page for this release)

@jtpio

0.7.3

(full changelog)

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

(GitHub contributors page for this release)

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

0.7.2

(full changelog)

Merged PRs

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

Contributors to this release

(GitHub contributors page for this release)

@jasongrout | @jasongrout-db

0.7.1

(full changelog)

Merged PRs

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

Contributors to this release

(GitHub contributors page for this release)

@jasongrout

0.7.0

(full changelog)

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

(GitHub contributors page for this release)

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

0.6.0

(full changelog)

Maintenance and upkeep improvements

• Remove unneeded code #60 (@jtpio)

Other merged PRs

• Revert renaming the config properties #62 (@martinRenou)

Contributors to this release

(GitHub contributors page for this release)

@jtpio | @martinRenou

0.5.0

(full changelog)

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

(GitHub contributors page for this release)

@jasongrout | @martinRenou

0.4.9

(full changelog)

Merged PRs

• Add jupyterlite_dir config option #16 (@martinRenou)

Contributors to this release

(GitHub contributors page for this release)

@martinRenou

0.4.8

(full changelog)

Enhancements made

• Run jupyter lite with subprocess.run to not suppress stdout #55 (@jasongrout)
• Adopt the path convention of other directives like literalinclude #54 (@jasongrout)

Bugs fixed

• Fix federated extensions URLs #56 (@martinRenou)
• Allow whitespace in filenames #52 (@jasongrout)

Other merged PRs

• Clarify how to preview locally, view a notebook in fullscreen, and link config docs #45 (@joelostblom)

Contributors to this release

(GitHub contributors page for this release)

@jasongrout | @joelostblom | @martinRenou

0.4.7

(full changelog)

Merged PRs

• Improve iframe URL #43 (@martinRenou)

Contributors to this release

(GitHub contributors page for this release)

@martinRenou

0.4.6

(full changelog)

Merged PRs

• Replite code: Remove empty lines but not indentation #42 (@martinRenou)

Contributors to this release

(GitHub contributors page for this release)

@martinRenou

0.4.5

(full changelog)

Merged PRs

• Cleanup query strings with urllib #41 (@martinRenou)

Contributors to this release

(GitHub contributors page for this release)

@martinRenou

0.4.4

(full changelog)

Merged PRs

• Revert link fix #35 (@martinRenou)

Contributors to this release

(GitHub contributors page for this release)

@martinRenou

0.4.3

(full changelog)

Merged PRs

• Fix lite links #32 (@martinRenou)

Contributors to this release

(GitHub contributors page for this release)

@martinRenou

0.4.2

(full changelog)

Merged PRs

• Replite: Fix multiline support #30 (@martinRenou)
• Bail early if there was an error #29 (@martinRenou)

Contributors to this release

(GitHub contributors page for this release)

@martinRenou

0.4.1

(full changelog)

Merged PRs

• Make sure we don't add the ipynb source prefix twice #28 (@martinRenou)
• Add LICENSE and update author #26 (@martinRenou)
• Fix sphinx pinning #25 (@martinRenou)
• Add Jupyterlite logo to the docs #22 (@martinRenou)
• Improve documentation frontpage #20 (@martinRenou)

Contributors to this release

(GitHub contributors page for this release)

@martinRenou

0.4.0

(full changelog)

Merged PRs

• Add jupyterlite directive and rework docs #19 (@martinRenou)
• Retrolite directive: Show tree if no Notebook specified #18 (@martinRenou)
• Remove docs build from the CI #15 (@martinRenou)
• Fix notebook search #14 (@martinRenou)
• Updating docs #10 (@martinRenou)
• Add link to the ipycanvas docs in the README #9 (@martinRenou)
• Update README #8 (@martinRenou)
• Add basic CI #7 (@martinRenou)
• Fix missing options_spec in Retrolite directive #6 (@martinRenou)

Contributors to this release

(GitHub contributors page for this release)

@martinRenou | @psychemedia

0.3.0

(full changelog)

Contributors to this release

(GitHub contributors page for this release)

0.2.0

(full changelog)

Contributors to this release

(GitHub contributors page for this release)

@martinRenou