Skip to content

Changelog

  • examples folder is not required to be in a subfolder of docs anymore. Fixes #54. PR #92 by Louis-Pujol.

0.10.0 - Support for asynchronous code

  • Gallery scripts now support top-level asynchronous code. PR #90 by pmeier

0.9.0 - Pyvista

  • Pyvista can now be used in gallery examples as in sphinx-gallery. PR #91 by Louis-Pujol

0.8.0 - Mayavi

  • Mayavi can now be used in gallery examples just as in sphinx-gallery. PR #69 by GenevieveBuckley
  • Fixed for README.md that contains html comments. Fixes #85. PR #86 by AntoineD.

0.7.10 - sys.path is not reset between code blocks

  • sys.path modifications now persist across blocks of an example. sys.path is still reset after each example. PR #82 by Louis-Pujol.

0.7.9 - optipng and better error messages

  • Fixed AttributeError when optipng is installed and used through the compress_images option. PR #77 by Samreay
  • Swapped from deprecated disutils.version to packaging.version. PR #79 by Samreay
  • Re-raise errors for better ExtensionError messages, so users have full details about the original problem. PR #58 by GenevieveBuckley

0.7.8 - Bugfixes

  • Fixed Plugin 'gallery' option 'binder': Sub-option 'org': Required configuration not provided.. Fixes #62
  • Support relative path to mkdocs.yaml file using --config-file option. Fixes #63. PR #64 by fgrbr.

0.7.7 - Bugfixes and new python versions

  • Official support for python 3.10 and 3.11. PR #52 by GenevieveBuckley
  • Fixed AttributeError: MySubConfig has no '_pre_validate' with mkdocs version 1.4 or greater. Fixes #57

0.7.6 - Bugfixes

  • Fixed incorrect img srcset paths leading to figures not being displayed in gallery examples. Fixes #47
  • Fixed TypeError: startswith first arg must be str or a tuple of str, not WindowsPath when running with mkdocs serve. Fixes #45. PR #46 by mchaaler.

0.7.5 - Bugfixes

  • Examples expected to fail are now correctly skipped in case of identical md5 hash, too. Fixes #34. PR #39 by mchaaler.

0.7.4 - Bugfixes

This release was yanked because of #34.

0.7.3 - Bugfix

  • matplotlib was still not optional by default because of the associated image_scraper that was called even when not used. It is now truly optional. Fixed #24

0.7.2 - Misc. bug fixes and improvements

  • Fixed KeyError issue when using a minimalistic configuration. Fixed #22.
  • matplotlib is now optional. Fixed #24

0.7.1 - Packaging is now correct

  • Fixed packaging issue: static resources were not included in wheel. Adopted src/ layout. Fixed #19.

0.7.0 - Code output max height + updated one example

  • Code output now have a correct height limit. Fixed #7
  • Fixed the "Notebook Style Example" tutorial. Fixed #17

0.6.0 - All examples + Edit page link + Binder badges !

  • Completed the gallery of examples. Fixed #1
  • Fixed HTML repr (example 2, typically used to display pandas tables). Fixed #11
  • Binder badges now work correctly. Fixes #5
  • "Edit page" links (pencil icon at the top) now work as expected: they take the user to the source python file used to generate the page. It also works for gallery readme pages ! Fixes #8
  • backreferences files are now written but it is still not clear how they should be used in a mkdocs context, see #10
  • Fixed most flake8 issues and warnings.

0.5.0 - First public working release

Initial release with:

  • Basic features:
  • pages generation with markdown-based gallery examples. Currently only the material theme renders correctly
  • download buttons (both on each example and on the summaries) and page header link to the downloads section
  • subgalleries
  • gallery synthesis with proper icons and subgalleries
  • auto inclusion in the ToC (nav) with support for the section index pages feature
  • working mkdocs serve: correctly ignoring generated files to avoid infinite build loop
  • working mkdocs.yml configuration for most options

  • New option conf_script to configure via a script as in Sphinx-gallery.

  • All gallery examples from Sphinx-Gallery successfully translated, in particular:

  • LaTeX support works

  • Refactoring:

  • Using pathlib all over the place
  • Using f-string whenever possible
  • Object-oriented approach for configuration and dir/file names used in the generated files.