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
Support for the sphinx_codeautolink
extension
Basic support for the text
builder
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
Support for mathjax3_config
(for Sphinx >= 4)
Force loading MathJax on HTML pages generated from notebooks
(can be disabled with nbsphinx_assume_equations = False
)
Add support for data-footcite
HTML attribute
Disable automatic highlighting in notebooks,
setting highlight_language
is no longer needed
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+
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.
.ipynb_checkpoints
is automatically added to exclude_patterns
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
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
Automatic support for Jupyter widgets, customizable with
nbsphinx_widgets_path
(and nbsphinx_widgets_options
)
Add option nbsphinx_requirejs_path
(and nbsphinx_requirejs_options
)
Re-establish Python 2 compatibility (but the clock is ticking …)
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
Disable nbconvert
version 5.4 to avoid
issue #878
Locally linked files are only copied for Jupyter notebooks (and not anymore for other Sphinx source files)
Links to local files are rewritten for all Sphinx source files (not only Jupyter notebooks)
Enable notebook translations (NB: The use of reST strings is temporary!)
Add options nbsphinx_prolog
and nbsphinx_epilog
Links from *.rst
files to notebooks have to start with a slash
Basic support for widgets
CSS is now “responsive”, some new CSS classes
Add options nbsphinx_execute
and nbsphinx_execute_arguments
Separate “display priority” for HTML and LaTeX
Special CSS tuning for sphinx_rtd_theme
Replace info/warning <div>
elements with nbinfo
/nbwarning
Support for LaTeX math environments in Markdown cells
Add options nbsphinx_timeout
and nbsphinx_codecell_lexer
Add option nbsphinx_allow_errors
to globally ignore exceptions
Separate class nbsphinx.Exporter
No need to mention source_suffix
and source_parsers
in conf.py
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
Initial release