A Sphinx extension that builds an HTML gallery of examples from any set of Python scripts.
Provides
Requires
License
BSD-3-Clause
Changelog
* Tue Jan 27 2026 Dirk Müller <dmueller@suse.com>
- update to 0.20.0:
* Support for Python 3.8 dropped in this release. Requirement
is now Python >=3.10.
* Bump version 0.20.0
* MNT Add test for `_bool_eval` and add configs to `_bool_eval`
check
* Add POT, SKADA and TorchDR to the list in README
* Update instructions for converting script to notebook
* Add comment on path for sphinx_gallery_thumbnail_path
* DOC Add plotly to supported scrapers
* DOC: Add JUnit XML parsing example
* DOC Update junit doc
* [DOC] Add an example or index.rst file that allow example in
multiple sections
* Embed code links with dirhtml builder
* Fix typo in note about Binder/JupyterLite
* Remove "# noqa: E501" from end of text blocks
* allow git archives to have dynamic versioning
* Update FAQ with notebook and RST file guidance
* DOC: Add cards for the subsections on the main topic pages
* Fix sphinx warning
* MNT: Use names instead of indices for Block namedtuple
* FIX: Fix test_recommend_n_examples
* ENH: Use :doc: instead of :ref: to link to examples
* MAINT: Add MNE-Python doc build integration test
* Support plain .rst files as example inputs
* MNT Update jupyterlite-sphinx version in circle CI
* Sun Mar 30 2025 Dirk Müller <dmueller@suse.com>
- update to 0.19.0:
* Add block-level sphinx_gallery_capture_repr_block setting
* Fix minigallery duplicates and add tests and update
documenation
* Fix: Fix minigallery duplicates
* Fix incorrect paths for JupyterLite Notebook interface URLs,
unpin jupyterlite-sphinx, and update JupyterLite integration
docs
* BUG: make _anim_rst windows compatible
* Fix custom sort
* DOC Fixes to minigallery doc in configuration\.rst
* DOC Improve doc on linking code blocks
* Doc: mention color css property to hide link
* DOC Improve custom sort key docs
* Wed Nov 20 2024 Dirk Müller <dmueller@suse.com>
- update to 0.18.0:
* Allow to disable writing computation times #1385
* [ENH] Add option to render multiple images from same cell as
single-img #1384
* Fix indexst variable does not exist when own index gallery is
first #1383
* Wed Sep 25 2024 ecsos <ecsos@opensuse.org>
- Add %{?sle15_python_module_pythons}
* Sun Sep 08 2024 Dirk Müller <dmueller@suse.com>
- update to 0.17.1:
* FIX: Fix stability of stored compiled regex #1369 (larsoner)
* ENH: Improve _sanitize_rst #1366 (timhoffm)
* Obey prefer_full_module setting when finding backreferences
[#1364] (QuLogic)
* Fix linking to class attributes with prefer_full_module #1363
(QuLogic)
* Improve minigallery directive path input resolution #1360
(lucyleeow)
* FIX Allow str path minigallery entries when backreferences
off #1355 (lucyleeow)
* FIX generate zipfiles when index passed by user #1353
(lucyleeow)
* DOC Improve doc about joblib warnings #1367 (lucyleeow)
* DOC add note on filtering joblib warnings #1362 (lucyleeow)
* DOC Minor update to minigallery directive doc #1358
(lucyleeow)
* MNT Change mark and fixture names for adding files #1365
(lucyleeow)
* MNT Add warning when ‘examples_dirs’ and ‘gallery_dirs’
unequal lengths #1361 (lucyleeow)
* Update pyvista in doc CI #1352 (lucyleeow)
* MNT Bump version #1350 (lucyleeow)
* Introduction tooltip corresponds to the first paragraph #1344
(fgmacedo)
* FIX Jupyterlite in CircleCI artifact #1336 (lesteve)
* MNT: Rename README.rst to GALLERY_HEADER.rst #1321 (timhoffm)
* [ENH] Add custom thumbnails for failing examples #1313
(tsbinns)
* ENH integrate download/launcher links into pydata-sphinx-
theme secondary sidebar #1312 (Charlie-XIAO)
* add option for zip downloads #1299 (jamiecook)
* Allow setting animation format from gallery config #1243
(QuLogic)
* Fix handling of multi-module intersphinx registries #1320
(QuLogic)
* BUG: Fix bug w