Version History#

Version 0.9.7 – 2025-03-03 – PyPI – diff

  • Disable Sphinx 8.2+ (for now)

Version 0.9.6 – 2024-12-24 – PyPI – diff

  • Markdown: allow lists without leading blank line

Version 0.9.5 – 2024-08-13 – PyPI – diff

  • Miscellaneous fixes

Version 0.9.4 – 2024-05-06 – PyPI – diff

  • Require docutils >= 0.18.1

  • Minor fixes, documentation and CI updates

Version 0.9.3 – 2023-08-27 – PyPI – diff

  • Fix gallery regression in Sphinx 7.2

Version 0.9.2 – 2023-05-24 – PyPI – diff

  • Improve support for sphinx_immaterial theme

  • Improve support for links starting with #

  • Add support for in-text citations

  • LaTeX: Add support for admonition titles

Version 0.9.1 – 2023-03-14 – PyPI – diff

  • pandoc: disable “smart” option only for version 2.0+

Version 0.9.0 – 2023-03-12 – PyPI – diff

  • Split nbsphinx.py (a Python module) into:

    • nbsphinx/__init__.py (a Python package)

    • A standalone CSS file nbsphinx-code-cells.css_t

    • LaTeX style file nbsphinx.sty

  • Add custom HTML/CSS for thumbnail galleries

    • Separate CSS file nbsphinx-gallery.css

    • The CSS from Sphinx Gallery ('sphinx_gallery.load_style') cannot be used anymore

  • Use the last image in a notebook as the default thumbnail

Version 0.8.12 – 2023-01-19 – PyPI – diff

  • Implement “link” galleries (without nested sub-documents)

Version 0.8.11 – 2022-12-29 – PyPI – diff

  • LaTeX: apply code cell border style to all code blocks

Version 0.8.10 – 2022-11-13 – PyPI – diff

  • Fix handling of source_suffix

  • A few LaTeX fixes

Version 0.8.9 – 2022-06-04 – PyPI – diff

  • CSS: support tables in widgets

  • Avoid empty “raw” directive

Version 0.8.8 – 2021-12-31 – PyPI – diff

  • Support for the sphinx_codeautolink extension

  • Basic support for the text builder

Version 0.8.7 – 2021-08-10 – PyPI – diff

  • Fix assertion error in LaTeX build with Sphinx 4.1.0+

Version 0.8.6 – 2021-06-03 – PyPI – diff

  • Support for Jinja2 version 3

Version 0.8.5 – 2021-05-12 – PyPI – diff

  • Freeze Jinja2 version to 2.11 (for now, until a bugfix is found)

  • Add theme_comparison.py tool for creating multiple versions (with different HTML themes) of the docs at once

Version 0.8.4 – 2021-04-29 – PyPI – diff

  • Support for mathjax3_config (for Sphinx >= 4)

  • Force loading MathJax on HTML pages generated from notebooks (can be disabled with nbsphinx_assume_equations = False)

Version 0.8.3 – 2021-04-09 – PyPI – diff

  • Increase line_length_limit (for docutils 0.17+)

Version 0.8.2 – 2021-02-28 – PyPI – diff

  • Add support for data-footcite HTML attribute

  • Disable automatic highlighting in notebooks, setting highlight_language is no longer needed

Version 0.8.1 – 2021-01-18 – PyPI – diff

  • Minor fixes and documentation update

Version 0.8.0 – 2020-10-20 – PyPI – diff

  • Don’t overwrite Pygments background in notebook code cells. To get rid of those ugly greenish code blocks, remove pygments_style = 'sphinx' from your conf.py.

  • Switch documentation to insipid theme by default

  • Require Python 3.6+

Version 0.7.1 – 2020-06-16 – PyPI – diff

  • Avoid links on scaled images

Version 0.7.0 – 2020-05-08 – PyPI – diff

  • Warnings can be suppressed with suppress_warnings.

  • <img> tags are handled in Markdown cells; the alt, width, height and class attributes are supported.

  • CSS: prompts protrude into left margin if nbsphinx_prompt_width is too small. If you want to hide the prompts, use custom CSS.

Version 0.6.1 – 2020-04-18 – PyPI – diff

  • .ipynb_checkpoints is automatically added to exclude_patterns

Version 0.6.0 – 2020-04-03 – PyPI – diff

  • Thumbnail galleries (inspired by https://sphinx-gallery.github.io/)

  • nbsphinx-toctree as cell tag

  • Keyword arguments in nbsphinx_custom_formats

  • Python 2 support has been dropped

Version 0.5.1 – 2020-01-28 – PyPI – diff
Version 0.5.0 – 2019-11-20 – PyPI – diff

  • Automatic support for Jupyter widgets, customizable with nbsphinx_widgets_path (and nbsphinx_widgets_options)

Version 0.4.3 – 2019-09-30 – PyPI – diff

  • Add option nbsphinx_requirejs_path (and nbsphinx_requirejs_options)

Version 0.4.2 – 2019-01-15 – PyPI – diff

  • Re-establish Python 2 compatibility (but the clock is ticking …)

Version 0.4.1 – 2018-12-16 – PyPI – diff

  • Fix issue #266

Version 0.4.0 – 2018-12-14 – PyPI – diff

  • Support for “data-cite” HTML tags in Markdown cells

  • Add option nbsphinx_custom_formats

  • LaTeX macros \nbsphinxstartnotebook and \nbsphinxstopnotebook

  • Support for cell attachments

  • Add options nbsphinx_input_prompt and nbsphinx_output_prompt

  • Re-design LaTeX output of code cells, fix image sizes

Version 0.3.5 – 2018-09-10 – PyPI – diff

  • Disable nbconvert version 5.4 to avoid issue #878

Version 0.3.4 – 2018-07-28 – PyPI – diff

  • Fix issue #196 and other minor changes

Version 0.3.3 – 2018-04-25 – PyPI – diff

  • Locally linked files are only copied for Jupyter notebooks (and not anymore for other Sphinx source files)

Version 0.3.2 – 2018-03-28 – PyPI – diff

  • Links to local files are rewritten for all Sphinx source files (not only Jupyter notebooks)

Version 0.3.1 – 2018-01-17 – PyPI – diff

  • Enable notebook translations (NB: The use of reST strings is temporary!)

Version 0.3.0 – 2018-01-02 – PyPI – diff

  • Add options nbsphinx_prolog and nbsphinx_epilog

  • Links from *.rst files to notebooks have to start with a slash

Version 0.2.18 – 2017-12-03 – PyPI – diff

  • Fix issue #148

Version 0.2.17 – 2017-11-12 – PyPI – diff

  • Fix issue #146

Version 0.2.16 – 2017-11-07 – PyPI – diff

  • Fix issue #142

Version 0.2.15 – 2017-11-03 – PyPI – diff

  • Links to subsections are now possible in all source files

Version 0.2.14 – 2017-06-09 – PyPI – diff

  • Add option nbsphinx_kernel_name

Version 0.2.13 – 2017-01-25 – PyPI – diff

  • Minor fixes

Version 0.2.12 – 2016-12-19 – PyPI – diff

  • Basic support for widgets

  • CSS is now “responsive”, some new CSS classes

Version 0.2.11 – 2016-11-19 – PyPI – diff

  • Minor fixes

Version 0.2.10 – 2016-10-16 – PyPI – diff

  • Enable JavaScript output cells

Version 0.2.9 – 2016-07-26 – PyPI – diff

  • Add option nbsphinx_prompt_width

Version 0.2.8 – 2016-05-20 – PyPI – diff

  • Add options nbsphinx_execute and nbsphinx_execute_arguments

  • Separate “display priority” for HTML and LaTeX

Version 0.2.7 – 2016-05-04 – PyPI – diff

  • Special CSS tuning for sphinx_rtd_theme

  • Replace info/warning <div> elements with nbinfo/nbwarning

Version 0.2.6 – 2016-04-12 – PyPI – diff

  • Support for LaTeX math environments in Markdown cells

  • Add options nbsphinx_timeout and nbsphinx_codecell_lexer

Version 0.2.5 – 2016-03-15 – PyPI – diff

  • Add option nbsphinx_allow_errors to globally ignore exceptions

  • Separate class nbsphinx.Exporter

Version 0.2.4 – 2016-02-12 – PyPI – diff

  • Support for “nbsphinx-toctree” cell metadata

Version 0.2.3 – 2016-01-22 – PyPI – diff

  • Links from notebooks to local files can now be used

Version 0.2.2 – 2016-01-06 – PyPI – diff

  • Support for links to sub-sections in other notebooks

Version 0.2.1 – 2016-01-04 – PyPI – diff

  • No need to mention source_suffix and source_parsers in conf.py

Version 0.2.0 – 2015-12-27 – PyPI – diff

  • Add support for allow_errors and hidden metadata

  • Add custom reST template

  • Add nbinput and nboutput directives with HTML+CSS and LaTeX formatting

  • Turn nbsphinx into a Sphinx extension

Version 0.1.0 – 2015-11-29

Initial release