Releases: Chilipp/sphinx-nbexamples
v0.4.0: Added support for non-python notebooks and binder
This release adds support for non-python notebooks and the possibility to include links to binderhub-services (e.g. https://mybinder.org) in the docs.
Added
- Thanks to the efforts of @effigies in #3, #4, #5, #6, #7, #8, and #9 , we now support
README.md
files and non-python notebooks (see the bash example in the docs) - sphinx-nbexamples now supports including a link to binder services with buttons like in the converted notebook. See the docs on including a link to binder
Changed
v0.3.2: Fixed compatibility with nbconvert 5.5
Fixed compatibility with nbconvert 5.5
v0.3.1: Compatibility fix for sphinx>1.7.6
This patch fixes some minor logging issues with sphinx >1.7.6
Changed
- Minor compatibility fix for using the logger with Sphinx
- Corrected typos PR #1
v0.3.0: Implemented the removal of tagged cells
Added
The removal of tags for the converted rst file. With nbconvert 5.3 we have the nbconvert.preprocessors.TagRemovePreprocessor
available which gave the motivation to 4 new gallery configuration values,
-
remove_all_outputs_tags:
set
Tags indicating cells for which the outputs are to be matches tags in cell.metadata.tags. -
remove_cell_tags:
set
Tags indicating which cells are to be removed, matches tags in cell.metadata.tags. -
remove_input_tags:
set
Tags indicating cells for which input is to be removed, matches
tags in cell.metadata.tags. -
remove_single_output_tags:
set
Tags indicating which individual outputs are to be removed,
matches output i tags in cell.outputs[i].metadata.tags.
The tags specified by these configuration values will be removed in
the rst file.
Minor patch for linkgalleries directive
Changed
- Minor bug fix in option_spec of LinkGalleriesDirective
New linkgalleries directive
This release adds a linkgalleries
directive that creates links to example galleries of
other sphinx projects using the sphinx.ext.intersphinx
extension.
See the docs for more details
Added
- Added changelog
- Added linkgalleries directive
Changed
- The name of a thumbnail is now
reference + '_thumb.png'
where
reference
is the section label of the rst file - Reference labels are now all lower case
First official release
v0.1.0 Included features