Full Changelog

Implemented enhancements:

• Allow to disable writing computation times #1385 (bmwiedemann)
• [ENH] Add option to render multiple images from same cell as single-img #1384 (tsbinns)

Fixed bugs:

• Fix indexst variable does not exist when own index gallery is first #1383 (lucyleeow)

Project maintenance

• [pre-commit.ci] pre-commit autoupdate #1387 (pre-commit-ci[bot])
• Bump mamba-org/setup-micromamba from 1 to 2 in the actions group #1386 (dependabot[bot])
• [pre-commit.ci] pre-commit autoupdate #1380 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1379 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1378 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1377 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1376 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1375 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1373 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1372 (pre-commit-ci[bot])

Full Changelog

Fixed bugs:

• 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)

Documentation

• 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)

Project maintenance

• [pre-commit.ci] pre-commit autoupdate #1368 (pre-commit-ci[bot])
• MNT Change mark and fixture names for adding files #1365 (lucyleeow)
• MNT Add warning when 'examples_dirs' and 'gallery_dirs' unequal lengths #1361 (lucyleeow)
• [pre-commit.ci] pre-commit autoupdate #1357 (pre-commit-ci[bot])
• Update pyvista in doc CI #1352 (lucyleeow)
• [pre-commit.ci] pre-commit autoupdate #1351 (pre-commit-ci[bot])
• MNT Bump version #1350 (lucyleeow)

Support for Python 3.8 and Sphinx 4 dropped in this release. Requirement is now Python >= 3.9 and Sphinx >= 5.

Full Changelog

Implemented enhancements:

• 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)

Fixed bugs:

• Fix handling of multi-module intersphinx registries #1320 (QuLogic)
• BUG: Fix bug with traceback with SyntaxError #1301 (larsoner)

Documentation

• DOC Add napari to users #1346 (lucyleeow)
• DOC Fix nested_sections #1339 (lucyleeow)
• DOC Improve nested_sections #1326 (lucyleeow)
• DOC: Remove definition lists from contribution guide #1318 (QuLogic)
• MNT: fixed documentation links in the readme #1310 (story645)

Project maintenance

• [pre-commit.ci] pre-commit autoupdate #1348 (pre-commit-ci[bot])
• MNT: Fix gallery_conf changes do not need to be returned #1347 (lucyleeow)
• [pre-commit.ci] pre-commit autoupdate #1345 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1342 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1338 (pre-commit-ci[bot])
• MNT: Sort imports and add to pre commit #1337 (lucyleeow)
• MNT: Refactor generate_file_rst #1335 (lucyleeow)
• MNT: Refactor _fill_gallery_conf_defaults #1334 (lucyleeow)
• MNT Use os.sep everywhere #1333 (lucyleeow)
• MNT: Refactor generate_dir_rst and generate_gallery_rst #1332 (lucyleeow)
• MNT: Add ipython to dev dependencies #1329 (lucyleeow)
• [pre-commit.ci] pre-commit autoupdate #1328 (pre-commit-ci[bot])
• Fix make file clean in tinybuild #1327 (lucyleeow)
• Bump the actions group with 5 updates #1325 (dependabot[bot])
• [pre-commit.ci] pre-commit autoupdate #1324 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1319 (pre-commit-ci[bot])
• Include dev dependencies in pyproject.toml and update docs on requirements #1317 (AlexSzatmary)
• [pre-commit.ci] pre-commit autoupdate #1314 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1311 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1307 (pre-commit-ci[bot])
• MAINT Add sphinxcontrib-video to dev requirements #1305 (lucyleeow)
• [pre-commit.ci] pre-commit autoupdate #1304 (pre-commit-ci[bot])
• MNT: Turn the block tuple into a namedtuple #1303 (timhoffm)
• [pre-commit.ci] pre-commit autoupdate #1300 (pre-commit-ci[bot])
• lint: define codespell in pyproject.toml #1298 (Borda)
• MAINT Bump version 0.17 #1297 (lucyleeow)

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:

• BUG: Fix serialization with Sphinx 7.3 #1289 (larsoner)
• ENH: minigallery_sort_order on full path #1253 (story645)
• BUG: UnicodeDecodeError in recommender #1244 (Charlie-XIAO)

Documentation

• DOC Update FFMpeg note in conf animation docs #1292 (lucyleeow)
• readme: adding quickstart section #1291 (Borda)
• readme: add link to docs #1288 (Borda)
• DOC Clarify sub level example gallery #1281 (lucyleeow)
• DOC Mention image_srcset config in scraper section in advanced.rst #1280 (lucyleeow)
• BUG: Fix errors in example usage of ignore_repr_types and reset_argv #1275 (speth)
• DOC Use 'nested_sections' True for docs #1263 (lucyleeow)
• fix: Missing full stop in download message #1255 (AlejandroFernandezLuces)
• Add HyperSpy and kikuchipy to 'who uses' #1247 (jlaehne)
• DOC: Fix formatting in contribute.rst #1237 (StefRe)

Project maintenance

• [pre-commit.ci] pre-commit autoupdate #1294 (pre-commit-ci[bot])
• Fix typo in test_fileno #1287 (lucyleeow)
• [pre-commit.ci] pre-commit autoupdate #1284 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1279 (pre-commit-ci[bot])
• Remove leftover config checking of image_srcset #1278 (lucyleeow)
• [pre-commit.ci] pre-commit autoupdate #1277 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1273 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1272 (pre-commit-ci[bot])
• More informative title for 'check label' CI workflow #1271 (lucyleeow)
• pyproject: cleaning pytest config #1269 (Borda)
• allow call script as pkg entry #1268 (Borda)
• refactor: migrate to pyproject.toml #1267 (Borda)
• lint: enable sphinx-lint for Sphinx extension #1266 (Borda)
• ci: associate install.sh with used job #1265 (Borda)
• lint: switch from Black to Ruff's "Black" #1264 (Borda)
• [pre-commit.ci] pre-commit autoupdate #1260 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1257 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1256 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1252 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1251 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1249 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1248 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1246 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1245 (pre-commit-ci[bot])
• Fix AST deprecation warnings #1242 (QuLogic)
• Simplify Matplotlib scraper #1241 (QuLogic)
• [pre-commit.ci] pre-commit autoupdate #1239 (pre-commit-ci[bot])
• MAINT: Fix deployment #1236 (larsoner)
• MAINT Bump version and update maintainers.rst #1234 (lucyleeow)

Full Changelog

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

Implemented enhancements:

• ENH: Improve logging visibility of errors and filenames #1225 (larsoner)
• ENH: Improve API usage graph #1203 (larsoner)
• ENH: Always write sg_execution_times and make DataTable #1198 (larsoner)
• ENH: Write all computation times #1197 (larsoner)
• ENH: Support source files in any language #1192 (speth)
• FEA Add examples recommender system #1125 (ArturoAmorQ)

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

• DOC Put configuration list under headings #1230 (lucyleeow)
• DOC: contributing guide #1223 (story645)
• DOC Note support for python 3.7 dropped in release notes #1199 (lucyleeow)

Project maintenance

• [pre-commit.ci] pre-commit autoupdate #1231 (pre-commit-ci[bot])
• MAINT Add extras_require in setup.py #1229 (lucyleeow)
• [pre-commit.ci] pre-commit autoupdate #1227 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1224 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1219 (pre-commit-ci[bot])
• MAINT: pydata-sphinx-theme #1218 (larsoner)
• MAINT: Improve CircleCI time #1216 (larsoner)
• [pre-commit.ci] pre-commit autoupdate #1215 (pre-commit-ci[bot])
• MAINT: Move to GHA #1214 (larsoner)
• [pre-commit.ci] pre-commit autoupdate #1206 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1201 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1196 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1194 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1191 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1189 (pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #1187 (pre-commit-ci[bot])
• MAINT: Bump ver #1185 (larsoner)

Full Changelog

Implemented enhancements:

• MAINT Update backreferences docs and add tests #1154 (lucyleeow)
• Remove extra spaces in reported running time #1147 (stefanv)

Fixed bugs:

• MAINT: Fix for Sphinx 7.2 #1176 (larsoner)
• updated mpl gui warning catcher to new error message #1160 (story645)
• Ensure consistent encoding for md5sum generation #1159 (sdhiscocks)
• Maint: Fix app.builder.outdir as Sphinx now using pathlib #1155 (lucyleeow)
• Make _LoggingTee compatible with TextIO #1151 (o-laurent)
• MAINT: Replace build_sphinx with sphinx-build #1139 (oscargus)
• Set table.dataframe width to auto in CSS file close #1128 #1137 (photoniker)

Documentation

• DOC Fix typo in _get_docstring_and_rest docstring #1182 (lucyleeow)
• DOC Fix Jupyterlite config example in configuration.rst #1181 (lucyleeow)
• DOC Update basics gallery name #1153 (lucyleeow)
• DOC: Add link to sphinxcontrib-svg2pdfconverter #1145 (oscargus)
• MNT: Add a few badges #1143 (oscargus)
• MAINT: Fix Zenodo reference #1140 (oscargus)
• Add OpenTURNS to "who uses" list #1133 (jschueller)
• Correctly hide download buttons #1131 (timhoffm)

Project maintenance

• MAINT: Force PRs to be labeled properly #1183 (larsoner)
• MAINT Add to test_identify_names so class property tested #1180 (lucyleeow)
• MAINT Lint - fix ast node type in docstrings #1179 (lucyleeow)
• MAINT Move figure_rst path testing to own unit test #1173 (lucyleeow)
• MAINT Remove unused parametrize in test_figure_rst_srcset #1172 (lucyleeow)
• MAINT Parametrize notebook first/last cell test #1171 (lucyleeow)
• MAINT Lint api usage #1170 (lucyleeow)
• MAINT Fix lint, clean and expand docstrings #1169 (lucyleeow)
• [pre-commit.ci] pre-commit autoupdate #1167 (pre-commit-ci[bot])
• MAINT: yamllint #1166 (larsoner)
• ENH: Use pre-commit #1165 (larsoner)
• MAINT: black . #1164 (larsoner)
• MAINT: Make outdated check better #1161 (larsoner)
• Use pathlib for url _embed_code_links #1157 (lucyleeow)
• MAINT: Speed up conda solving #1156 (larsoner)
• MNT: Change % formatting to f-strings #1135 (StefRe)
• MAINT: Update deps and intersphinx links #1132 (larsoner)

* This Changelog was automatically generated by github_changelog_generator

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:

• ENH Clean-up code by early initialization of sphinx_gallery_conf #1120 (lesteve)
• FIX JupyterLite button links #1115 (lesteve)
• Fix thumbnail text formatting #1108 (StefRe)
• Fix JupyterLite URL with nested gallery folders #1105 (lesteve)
• Avoid potentially changing the matplotlib backend when scraping #1102 (ayshih)
• Remove default '%matplotlib inline' line #1099 (ArturoAmorQ)
• FIX: Only ANSI sanitize non-HTML output #1097 (sdhiscocks)
• BUG: Fix bug with show_api_usage #1095 (larsoner)
• FIX: Add blank line at end of table of contents block #1094 (sdhiscocks)

API changes

• API: Remove deprecated mayavi support #1090 (larsoner)

Documentation

• Add reference to qtgallery (Qt scraper) #1126 (aganders3)
• DOC: Unify abbreviations of reStructuredText #1118 (StefRe)
• Add PyGMT to list "Who uses Sphinx-Gallery" #1114 (yvonnefroehlich)
• DOC Update JupyterLite doc after JupyterLite 0.1.0b19 release #1106 (lesteve)
• Fix project list #1101 (StefRe)
• DOC: Document changes #1098 (larsoner)
• DOC: Document point release changes #1096 (larsoner)

Project maintenance

• MAINT: Use non-aliased status_iterator #1124 (larsoner)
• CLN Clean up naming of early config validation #1123 (lesteve)
• MNT: Remove Python 2 leftovers #1116 (StefRe)
• MNT: Sync minimum sphinx version with README.rst #1110 (StefRe)
• CI Install jupyterlite-pyodide-kernel in CI #1107 (lesteve)
• Add test for setting a non-agg Matplotlib backend #1104 (ayshih)
• MAINT: Bump version to dev #1089 (larsoner)

Fixed bugs:

• FIX: Only ANSI sanitize non-HTML output #1097 (sdhiscocks)

Fixed bugs:

• BUG: Fix bug with show_api_usage #1095 (larsoner)
• FIX: Add blank line at end of table of contents block #1094 (sdhiscocks)

What's Changed

• MAINT: Bump to dev by @larsoner in #995
• Fix sphinx link typo in CHANGES by @alexisthual in #996
• [ENH, MRG] Make orphan of unused API entries by @alexrockhill in #983
• [MAINT, MRG] A few small leftovers from API usage by @alexrockhill in #997
• BUG: Short circuit when disabled by @larsoner in #999
• FIX: No orphan by @larsoner in #1000
• [MAINT, MRG] Add unused option for API usage, set as default by @alexrockhill in #1001
• BUG: Update for matplotlib by @larsoner in #1010
• FIX: role names by @StefRe in #1012
• Fix outdated import by @OverLordGoldDragon in #1016
• DOC Fix typo in scraper doc by @lucyleeow in #1018
• MNT: Fix required sphinx version by @StefRe in #1019
• MNT: Fix erroneous commit c6ed4e by @StefRe in #1021
• MNT: make "clean" behave the same on Windows as on Linux by @StefRe in #1020
• MAINT: Remove lingering ref by @larsoner in #1022
• DOC: fix 'Who uses Sphinx-Gallery' list by @StefRe in #1015
• MAINT: Check CI status by @larsoner in #1028
• Expose sphinx_gallery_conf in python_to_jupyter_cli by @OverLordGoldDragon in #1027
• [BUG, MRG] fix issue with api usage dict by @alexrockhill in #1033
• Fix "subsection_index_toctree referenced before assignment" by @OverLordGoldDragon in #1035
• Allow 2 decimal places in srcset by @OverLordGoldDragon in #1039
• Use descriptive link text for example page header by @betatim in #1040
• Update advanced usage examples by @HealthyPear in #1045
• Reorder paragraphs in the minigallery documentation by @ayshih in #1048
• MAINT: Fix CIs by @larsoner in #1046
• Fixed a bug where backslashes in paths could show up in RST files by @ayshih in #1047
• MAINT: Work around IPython lexer bug by @larsoner in #1052
• BUG: Fix full check by @larsoner in #1053
• BUG: Remove ignore blocks when remove_config_comments=True by @guberti in #1059
• MAINT: Update CIs by @larsoner in #1061
• Fix broken links when using dirhtml builder by @mgoulao in #1060
• Adds plot_gallery as a string by default by @melissawm in #1062
• MAINT: Rotate CircleCI key by @larsoner in #1064
• MAINT: Fix CIs by @larsoner in #1074
• TST: gallery inventory/re-structure tinybuild by @jklymak in #1072
• DOC: Switch to pydata-sphinx-theme by @larsoner in #1013
• ENH: allow rst files to pass through by @jklymak in #1071
• FIX: indentation fix by @jklymak in #1077
• API: Deprecate mayavi scraper by @larsoner in #1083
• DOC: Add note for html-noplot to suppress config warning. by @rossbar in #1084
• MNT: fix subfolder README detection by @jklymak in #1086
• Jupyterlite integration by @amueller in #977
• Bugfix thumbnail text formatting by @alexisthual in #1005
• MAINT: Release 0.12.0 by @larsoner in #1088

New Contributors

• @alexrockhill made their first contribution in #983
• @OverLordGoldDragon made their first contribution in #1016
• @betatim made their first contribution in #1040
• @HealthyPear made their first contribution in #1045
• @mgoulao made their first contribution in #1060
• @melissawm made their first contribution in #1062

Full Changelog: v0.11.1...v0.12.0