Sphinx Gallery Versions Save

Sphinx extension for automatic generation of an example gallery

v0.16.0

6 days ago

Sphinx 7.3.0 and above changed caching and serialization checks. Now instead of passing instantiated classes like ResetArgv(), classes like FileNameSortKey, or callables like notebook_modification_function in sphinx_gallery_conf, you should pass fully qualified name strings to classes or callables. If you change to using name strings, you can simply use a function as the use of classes to ensure a stable __repr__ would be redundant.

See importing_callables for details.

Implemented enhancements:

  • ENH: Allow plain list as subsection_order and support a wildcard #1295 (timhoffm)
  • [ENH] Minigallery can take arbitrary files/glob patterns as input #1226 (story645)

Fixed bugs:

Documentation

Project maintenance

v0.15.0

5 months ago

Full Changelog

Support for Python 3.7 dropped in this release. Requirement is now Python >=3.8. Pillow added as a dependency.

Implemented enhancements:

Fixed bugs:

  • FIX Copy JupyterLite contents early so it runs before jupyterlite_sphinx build-finished #1213 (lesteve)
  • BUG: Fix bug with orphan sg_api_usage #1207 (larsoner)
  • MAINT Fix check for mismatched "ignore" blocks #1193 (speth)
  • Avoid importing new modules in backrefs #1177 (aganders3)

Documentation

Project maintenance

v0.14.0

8 months ago

Full Changelog

Implemented enhancements:

Fixed bugs:

Documentation

Project maintenance

* This Changelog was automatically generated by github_changelog_generator

v0.13.0

1 year ago

Full Changelog

Implemented enhancements:

  • ENH: Create backreferences for default roles #1122 (StefRe)
  • ENH raise error in check_jupyterlite_conf with unknown key #1119 (lesteve)
  • ENH Add functionality to modify Jupyterlite notebooks based on their content #1113 (lesteve)
  • ENH: Add support for WebP #1111 (StefRe)

Fixed bugs:

API changes

Documentation

Project maintenance

v0.12.2

1 year ago

Fixed bugs:

v0.12.1

1 year ago

Fixed bugs:

v0.12.0

1 year ago

What's Changed

New Contributors

Full Changelog: https://github.com/sphinx-gallery/sphinx-gallery/compare/v0.11.1...v0.12.0

v0.11.1

1 year ago

What's Changed

Full Changelog: https://github.com/sphinx-gallery/sphinx-gallery/compare/v0.11.0...v0.11.1

v0.11.0

1 year ago

What's Changed

New Contributors

Full Changelog: https://github.com/sphinx-gallery/sphinx-gallery/compare/v0.10.1...v0.11.0

v0.10.1

2 years ago

Support for Python 3.6 dropped in this release. Requirement is Python >=3.7.

Implemented enhancements:

  • Feature Request: reset_modules to be applied after each or all examples #866
  • Enable reset_modules to run either before or after examples, or both #870 (MatthewFlamm)

Fixed bugs:

  • embed_code_links throwing <exception: list indices must be integers or slices, not str> #879
  • 0.10.0 breaks sphinx_gallery.load_style #878
  • Add imagesg directive in load style #880 (lucyleeow)
  • Use bools for 'plot_gallery' in sphinx_gallery_conf #863 (timhoffm)

Closed issues:

  • Idea: make galleries out of the "testing" folder to use each unit test as an example. #875
  • Output text in dark mode is not visible #869
  • Using a .gif image works in .rst sphinx build but not inside example generated with sphinx-gallery #868
  • How to avoid capture of tqdm progress bars #867

Merged pull requests: