Version History¶
- Version 0.8.8 – 2021-12-31 – PyPI – diff
Support for the
sphinx_codeautolink
extensionBasic support for the
text
builder
- 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.2 – 2021-02-28 – PyPI – diff
Add support for
data-footcite
HTML attributeDisable automatic highlighting in notebooks, setting
highlight_language
is no longer needed
- 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 yourconf.py
.Switch documentation to insipid theme by default
Require Python 3.6+
- Version 0.7.0 – 2020-05-08 – PyPI – diff
Warnings can be suppressed with
suppress_warnings
.<img>
tags are handled in Markdown cells; thealt
,width
,height
andclass
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 toexclude_patterns
- Version 0.6.0 – 2020-04-03 – PyPI – diff
Thumbnail galleries (inspired by https://sphinx-gallery.github.io/)
nbsphinx-toctree
as cell tagKeyword arguments in
nbsphinx_custom_formats
Python 2 support has been dropped
- Version 0.5.1 – 2020-01-28 – PyPI – diff
This will be the last release supporting Python 2.x!
Support for https://github.com/choldgraf/sphinx-copybutton
Executed notebooks are now saved in the HTML output directory
- Version 0.5.0 – 2019-11-20 – PyPI – diff
Automatic support for Jupyter widgets, customizable with
nbsphinx_widgets_path
(andnbsphinx_widgets_options
)
- Version 0.4.3 – 2019-09-30 – PyPI – diff
Add option
nbsphinx_requirejs_path
(andnbsphinx_requirejs_options
)
- Version 0.4.2 – 2019-01-15 – PyPI – diff
Re-establish Python 2 compatibility (but the clock is ticking …)
- 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
andnbsphinx_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.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
andnbsphinx_epilog
Links from
*.rst
files to notebooks have to start with a slash
- Version 0.2.12 – 2016-12-19 – PyPI – diff
Basic support for widgets
CSS is now “responsive”, some new CSS classes
- Version 0.2.8 – 2016-05-20 – PyPI – diff
Add options
nbsphinx_execute
andnbsphinx_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 withnbinfo
/nbwarning
- Version 0.2.6 – 2016-04-12 – PyPI – diff
Support for LaTeX math environments in Markdown cells
Add options
nbsphinx_timeout
andnbsphinx_codecell_lexer
- Version 0.2.5 – 2016-03-15 – PyPI – diff
Add option
nbsphinx_allow_errors
to globally ignore exceptionsSeparate class nbsphinx.Exporter
- Version 0.2.1 – 2016-01-04 – PyPI – diff
No need to mention
source_suffix
andsource_parsers
inconf.py
- Version 0.2.0 – 2015-12-27 – PyPI – diff
Add support for
allow_errors
andhidden
metadataAdd 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