NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
PyPI
PyPI, #5190 most downloaded on PyPI
A Jupyter Notebook Sphinx reader built on top of the MyST markdown parser.
Latest stable
1.4.0
Last release 8 months ago
02 Mar 2026
Ships fairly regularly
a new release about every 5 months
Most releases are documented
notes for 32 of 42 stable releases
Nothing withdrawn
no release was ever pulled
7 years old
49 releases · first in 2020
Drag across the ruler to compare, or tap a release to open it.
<!-- Release notes generated using configuration in .github/release.yml at v1.4.0 -->
<!-- Release notes generated using configuration in .github/release.yml at v1.4.0 -->
Full Changelog: https://github.com/executablebooks/MyST-NB/compare/v1.3.0...v1.4.0
<!-- Release notes generated using configuration in .github/release.yml at master -->
<!-- Release notes generated using configuration in .github/release.yml at master -->
PendingGlueReference in generate_any_nodes by @StFroese in https://github.com/executablebooks/MyST-NB/pull/675Full Changelog: https://github.com/executablebooks/MyST-NB/compare/v1.2.0...v1.3.0
Your coding agent can read these notes before it upgrades. Set up the MCP server →
ENH: Support translated notebooks #600 (@OriolAbril)
configuration key to readthedocs.yml #657 (@sneakers-the-rat)(GitHub contributors page for this release)
@agoose77 | @bsipocz | @flying-sheep | @je-cook | @maximlt | @mforbes | @OriolAbril | @pre-commit-ci | @sneakers-the-rat
configuration key to readthedocs.yml by @sneakers-the-rat in https://github.com/executablebooks/MyST-NB/pull/657ENH: Support translated notebooks #600 (@OriolAbril)
configuration key to readthedocs.yml #657 (@sneakers-the-rat)(GitHub contributors page for this release)
@agoose77 | @bsipocz | @flying-sheep | @je-cook | @OriolAbril | @pre-commit-ci | @sneakers-the-rat
(GitHub contributors page for this release)
@agoose77 | @basnijholt | @bryanwweber | @bsipocz | @choldgraf | @chrisjsewell | @dependabot | @LecrisUT | @OriolAbril | @tupui | @welcome
FIX: output metadata overwrites image size for all following images #609 (@aeisenbarth)
(GitHub contributors page for this release)
@aeisenbarth | @agoose77 | @jeertmans | @OriolAbril | @sstroemer | @welcome
ENH: pass-through image metadata #588 (@flying-sheep)
findall instead of traverse #585 (@agoose77)(GitHub contributors page for this release)
@agoose77 | @cisaacstern | @dependabot | @flying-sheep | @ma-sadeghi | @peytondmurray | @PhilipVinc | @sphuber | @welcome
FEAT: allow any value for expr #429 (@agoose77)
file_regression fixture for Sphinx backwards compatibility #536 (@je-cook)(GitHub contributors page for this release)
@agoose77 | @aleivag | @choldgraf | @chrisjsewell | @cisaacstern | @codecov | @dependabot | @GlobalMin | @je-cook | @joeldodson | @kianmeng | @kloczek | @LecrisUT | @michaelweinold | @mmcky | @paugier | @peytondmurray | @PhilipVinc | @pre-commit-ci | @rowanc1 | @sphuber | @tupui | @WarrenWeckesser | @welcome | @Yoshanuikabundi
Nothing published for this version
Nothing published for this version
This is primarily a maintenance release to support newer versions of dependencies and fix a few bugs.
This is primarily a maintenance release to support newer versions of dependencies and fix a few bugs.
sphinx-design #486 (@agoose77, @choldgraf)The following people contributed discussions, new ideas, code and documentation contributions, and review. See our definition of contributors.
(GitHub contributors page for this release)
@agoose77 (activity) | @choldgraf (activity) | @chrisjsewell (activity) | @dependabot (activity) | @kolibril13 (activity) | @michaelaye (activity) | @OriolAbril (activity) | @pre-commit-ci (activity)
👌 IMPROVE: hide-output button by @chrisjsewell in https://github.com/executablebooks/MyST-NB/pull/450
hide-output button by @chrisjsewell in https://github.com/executablebooks/MyST-NB/pull/450Full Changelog: https://github.com/executablebooks/MyST-NB/compare/v0.17.0...v0.17.1
hide-output button (#450)
This now uses the same margin color as the cell source and, when the cell source is present, is "connected" to that, to form a single element.
See Hide cell contents for more information.📚 DOCS: correct key name for cell metadata by @agoose77 in https://github.com/executablebooks/MyST-NB/pull/428
Full Changelog: https://github.com/executablebooks/MyST-NB/compare/v0.16.0...v0.17.0
👌 IMPROVE: Replace sphinx-togglebutton with built-in functionality (#446) This allows for tighter integration with myst-nb:
See Hide cell contents for more information.
🐛 FIX: Inline exec variables with multiple outputs (#440) Previously, it was assumed that a variable evaluation would only ever create 0 or 1 outputs. Multiple are now allowed.
👌 IMPROVE: cache bust changes to CSS (#447)
👌 IMPROVE: Move CSS colors to variables (#448)
📚 DOCS: Fix link in README by @bsipocz in https://github.com/executablebooks/MyST-NB/pull/415
Full Changelog: https://github.com/executablebooks/MyST-NB/compare/v0.15.0...v0.16.0
🔀 MERGE: Add inline execution and variable evaluation by @chrisjsewell in https://github.com/executablebooks/MyST-NB/pull/414
Full Changelog: https://github.com/executablebooks/MyST-NB/compare/v0.14.0...v0.15.0
✨ NEW: Add inline execution mode and eval role/directive, for inserting code variables directly into the text flow of your documentation!
See Inline variable evaluation for more information.
DOCS: Fix typo: Controling -> Controlling by @psychemedia in https://github.com/executablebooks/MyST-NB/pull/383
glue:figure by @chrisjsewell in https://github.com/executablebooks/MyST-NB/pull/403nb_execution_raise_on_error config by @chrisjsewell in https://github.com/executablebooks/MyST-NB/pull/404nb_kernel_rgx_aliases option by @chrisjsewell in https://github.com/executablebooks/MyST-NB/pull/410Full Changelog: https://github.com/executablebooks/MyST-NB/compare/v0.13.2...v0.14.0
This release encompasses a major rewrite of the entire library and its documentation, primarily in #380 and #405.
A number of configuration option names have been changed, such that they now share the nb_ prefix.
Most of the deprecated names will be auto-converted at the start of the build, emitting a warning such as:
WARNING: 'jupyter_execute_notebooks' is deprecated for 'nb_execution_mode' [mystnb.config]
nb_render_priority has been removed and replaced by nb_mime_priority_overrides, which has a different format and is more flexible. See Outputs MIME priority for more information.
As per the changes in myst_parser, the dollarmath syntax extension is no longer included by default.
To re-add this extension, ensure that it is specified in your conf.py: myst_enable_extensions = ["dollarmath"].
For cell-level configuration the top-level key render has now been deprecated for mystnb.
For example, replace:
```{code-cell}
---
render:
image:
width: 200px
---
...
```
with:
```{code-cell}
---
mystnb:
image:
width: 200px
---
...
```
render will currently still be read, if present, and will issue a [mystnb.cell_metadata_key] warning.
The jupyter_sphinx_require_url and jupyter_sphinx_embed_url configuration options are no longer used by this package, and are replaced by nb_ipywidgets_js.
See the configuration section for more details.
The ipywidgets package has been removed from the requirements. If required, please install it specifically.
The structure of the docutils AST and nodes produced by MyST-NB has been fully changed, for compatibility with the new docutils only functionality. See the API documentation for more details.
The renderer plugin system (used by the myst_nb.renderers entry point) has also been completely rewritten,
so any current existing renderers will no longer work.
There is also now a new myst_nb.mime_renderers entry point, to allow for targeted rendering of specific code-cell output MIME types.
See Customise the render process for more information.
By default, glue roles and directives now only work for keys within the same document.
To reference glued content in a different document, the glue:any directive allows for a doc option and glue:any/glue:text roles allow the (relative) doc path to be added, for example:
```{glue:any} var_text
:doc: other.ipynb
```
{glue:text}`other.ipynb::var_float:.2E`
This cross-document functionality is currently restricted to only text/plain and text/html output MIME types, not images.
See Embedding outputs as variables for more details.
ipywidgetsjupyter_sphinxnbconvertPython: 3.6+ -> 3.7+myst_parser: 0.15 -> 0.17jupyter-cache: 0.4 -> 0.5sphinx-togglebutton: 0.1 -> 0.3The following is a non-exhaustive list of new features and improvements, see the rest of the documentation for all the changes.
Multi-level configuration (global (conf.py) < notebook level metadata < cell level metadata)
nb_number_source_lines, nb_remove_code_source, nb_remove_code_outputs, nb_render_error_lexer, nb_execution_raise_on_error, nb_kernel_rgx_aliasesAdded mystnb-quickstart and mystnb-to-jupyter CLI commands.
MyST text-based notebooks can now be specified by just:
---
file_format: mystnb
kernelspec:
name: python3
---
as opposed to the alternative jupytext top-matter. See Text-based Notebooks for more details.
docutils API/CLI with command line tools, e.g. mystnb-docutils-html
glue roles and directivesParallel friendly (e.g. sphinx-build -j 4 can execute four notebooks in parallel)
Page specific loading of ipywidgets JavaScript, i.e. only when ipywidgets are present in the notebook.
Added raw cell rendering, with the raw-cell directive.
See Raw cells authoring for more details.
Added MIME render plugins. See Customise the render process for more details.
Better log info/warnings, with type.subtype specifiers for warning suppression.
See Warning suppression for more details.
Reworked jupyter-cache integration to be easier to use (including parallel execution)
Added image options to glue:figure
New glue:md role/directive includes nested parsing of MyST Markdown.
See Embedding outputs as variables for more details.
Improved nb-exec-table directive (includes links to documents, etc)
This release improves for cell outputs and brings UI improvements for toggling cell inputs and outputs. It also includes several bugfixes.
This release improves for cell outputs and brings UI improvements for toggling cell inputs and outputs. It also includes several bugfixes.
nb_render_plugin for glue nodes #337 (@bryanwweber)See CHANGELOG.md
See CHANGELOG.md
✨ NEW: nb_merge_streams configuration [PR #364]
If nb_merge_streams=True, all stdout / stderr output streams are merged into single outputs. This ensures deterministic outputs.
See CHANGELOG.md for details
See CHANGELOG.md for details
sphinx v4 ⬆️The primary change in this release is to update the requirements of myst-nb from sphinx>=2,<4 to sphinx>=3,<5 to
support sphinx>=4 [PR #356].
0.15.2 [PR #353]Many thanks to @akhmerov, @bollwyvl, @choldgraf, @chrisjsewell, @juhuebner, @mmcky
Nothing published for this version
Nothing published for this version
Nothing published for this version
See CHANGELOG.md
See CHANGELOG.md
0.3.2: fixes Notebook code has no file extension metadata warning)3.6: to use new entry point loading interface(0.12.2 and 0.12.3 fix a regression, when working with the entry point loading interface)
See CHANGELOG.md
See CHANGELOG.md
This release adds an experimental MyST-NB feature to enable loading of code from a file
for code-cell directives using a :load: <file> option.
Usage information is available in the docs
Minor update to handle MyST-Parser v0.13.3 and v4.5 notebooks.
Minor update to handle MyST-Parser v0.13.3 and v4.5 notebooks.
See CHANGELOG.md
See CHANGELOG.md
This release updates MyST-Parser to v0.13,
which is detailed in the myst-parser changelog.
The primary change is to the extension system, with extensions now all loaded via myst_enable_extensions = ["dollarmath", ...],
and a number of extensions added or improved.
Nothing published for this version
See CHANGELOG.md
See CHANGELOG.md
Minor fixes:
See CHANGELOG.md
See CHANGELOG.md
⬆️ UPGRADE: myst-parser v0.12.9
: Minor bug fixes and enhancements / new features
See CHANGELOG.md
See CHANGELOG.md
⬆️ UPGRADE: jupyter-sphinx v0.3, jupyter-cache v0.4.1 and nbclient v0.5.
: These upgrades allow for full Windows OS compatibility, and improve the stability of notebook execution on small machines.
👌 IMPROVE: Formatting of stderr is now similar to stdout, but with a slight red background.
🧪 TESTS: Add Windows CI
See CHANGELOG.md
See CHANGELOG.md
⬆️ UPGRADE: myst-parser patch version
: to ensure a few new features and bug fixes are incorporated (see its CHANGELOG.md)
See CHANGELOG.md
See CHANGELOG.md
More configuration!
nb_output_stderr
(see removing stderr)nb_render_key configuration
(see formatting outputs)auto execution not recognising (and skipping) notebooks with existing outputsSee CHANGELOG.md
See CHANGELOG.md
This versions see's many great changes; utilising the ⬆️ upgrade to myst-parser=v0.12
and accompanying ⬆️ upgrade to sphinx=v3,
as well as major refactors to the execution (#236) and code output rendering (#243).
Plus much more configuration options, to allow for a more configurable workflow (the defaults work great as well!).
Below is a summary of the changes, and you can also check out many examples in the documentation, https://myst-nb.readthedocs.io/, and the MyST-Parser Changelog for all the new Markdown parsing features available: https://github.com/executablebooks/MyST-Parser.
Custom notebook formats:
Configuration and logic has been added for designating additional file types to be converted to Notebooks, which are then executed & parsed in the same manner as regular Notebooks. See Custom Notebook Formats for details.
Allow for configuration of render priority (per output format) with nb_render_priority.
The code cell output renderer class is now loaded from an entry-point, with a configurable name, meaning that anyone can provide their own renderer subclass. See Customise the render process for details.
Assignment of metadata tags remove-stdout and remove-stderr for removal of the relevant outputs (see here)
Render text/markdown MIME types with an integrated CommonMark parser (see here).
Add code output image formatting, via cell metadata, including size, captions and labelling (see here).
Notebook outputs ANSI lexer which is applied to stdout/stderr and text/plain outputs, and is configurable via nb_render_text_lexer (see here).
Capture execution data in sphinx env, which can be output into the documentation, with the nb-exec-table directive. See Execution statistics for details.
Standardise auto/cache execution
Both now call the same underlying function (from jupyter-cache) and act the same.
This improves auto, by making it output error reports and not raising an exception on an error.
Additional config has also been added: execution_allow_errors and execution_in_temp.
As for for timeout, allow_errors can also be set in the notebook metadata.execution.allow_errors
This presents one breaking change, in that cache will now by default execute in a the local folder as the CWD (not a temporary one).
path_to_cache -> nb_path_to_cacheallowed_nb_exec_suffixes -> nb_allowed_exec_suffixesexcluded_nb_exec_paths -> nb_excluded_exec_pathsCellOutputBundleNodeCellOutputBundleNodeCellOutputRenderer class to contain render methodsget_doctree and get_and_resolve_doctree methodsAdd configuration for traceback in stderr
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Added a copy method to celloutputbundlenode #153 (@AakashGfude)
(GitHub contributors page for this release)
@AakashGfude | @choldgraf | @chrisjsewell | @codecov | @jstac | @mmcky | @phaustin
Nothing published for this version
This releases moves to the markdown-it-py markdown parser implementation, concurrently with myst-parser. Additionally:
Mainly implemented in #107
This releases moves to the markdown-it-py markdown parser implementation, concurrently with myst-parser. Additionally:
<cell index>*10000 + <line number>. This is a simple solution to addresses #71, that doesn't require any complex overrides of the sphinx reporting machinery.env and use a separate function is_valid_exec_file. Also added testsNothing published for this version
Nothing published for this version
This release adds execution and cacheing functionality using jupyter-cache. See the execution and cacheing documentation for information on how to ena
This release adds execution and cacheing functionality using jupyter-cache. See the execution and cacheing documentation for information on how to enable and configure this functionality.
Nothing published for this version
This adds a prototype functionality for "glue and paste" with MyST-NB. It closes #4
This adds a prototype functionality for "glue and paste" with MyST-NB. It closes #4
You glue things into a notebook's metadata like this:
from myst_nb import glue
glue("your-key", an_object)
And it will run IPython's display on the object, then store the mimebundle at the key you specify.
When the notebooks are parsed with MyST-NB, it builds up a registry of all
the keys across all notebooks, so that you can then refer to them in the following ways:
You can paste it in markdown with a directive like this:
```{paste} your-key
```
Or you can add it in-line like this:
{paste}`your-key`
optionally:
{paste}`your-key:format-string`
See documentation for more details: https://myst-nb.readthedocs.io/en/latest/use/glue.html
Nothing published for this version
So that its pip install myst-nb rather than pip install MyST-NB
So that its pip install myst-nb rather than pip install MyST-NB
With the shiny new mistletoe-ebp API (see https://mistletoe-ebp.readthedocs.io/en/latest/using/intro.html#programmatic-use), the parsing process has b
With the shiny new mistletoe-ebp API (see https://mistletoe-ebp.readthedocs.io/en/latest/using/intro.html#programmatic-use), the parsing process has been refactored to be more inline with how it will occur for the text based representation:
SpanContainer (see https://mistletoe-ebp.readthedocs.io/en/latest/using/intro.html#the-parse-process)SphinxNBRenderer is applyed once on the full AST (rather than for each cell as was done previously).This involved creating a specific CodeCell mistletoe token, then adding an extra render method to SphinxRenderer that knows how to deal with it, basically using the code from https://github.com/ExecutableBookProject/MyST-NB/blob/d089de3c1140f72daf7c579be7637164ee548028/myst_nb/parser.py#L98
Note: this logic has been removed: https://github.com/ExecutableBookProject/MyST-NB/blob/d089de3c1140f72daf7c579be7637164ee548028/myst_nb/parser.py#L89
Since it is not compatible with the new process, as already discussed in #30
Nothing published for this version
One column per quarter.