Releases: sphinx-gallery/sphinx-gallery
Release v0.16.0
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 inadvanced.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)
Release v0.15.0
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
insetup.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)
Release v0.14.0
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
Release v0.13.0
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
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)
Release v0.12.2
Fixed bugs:
- FIX: Only ANSI sanitize non-HTML output #1097 (sdhiscocks)
Release v0.12.1
Fixed bugs:
- BUG: Fix bug with show_api_usage #1095 (larsoner)
- FIX: Add blank line at end of table of contents block #1094 (sdhiscocks)
Release v0.12.0
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
inpython_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
Release v0.11.1
Release v0.11.0
What's Changed
- Fix a few links in project lists by @ixjlyons in #883
- Fix "Out" layout for pydata-sphinx-theme by @timhoffm in #886
- Add PyVista examples! by @banesullivan in #888
- Fix matplotlib resetter _reset_matplotlib by @StefRe in #890
- Config capture_repr on file-by-file basis by @StefRe in #891
- FIX: Fix for latest pytest by @larsoner in #894
- DOC Update docs for Adding mini-galleries for API documentation by @StefRe in #899
- Use pseudo-elements for 'Out:' prefixing by @QuLogic in #896
- FIX: Pin pyvista by @larsoner in #901
- Fix matplotlib intersphinx url by @StefRe in #902
- DOC Fix example "Identifying function names in a script" by @StefRe in #903
- Honor show_signature by @jschueller in #909
- Css grid for thumbnails by @alexisthual in #906
- FIX: Azure by @larsoner in #915
- [WIP] Bugfix missing parent div for mini gallery by @alexisthual in #914
- MAINT: Remove LooseVersion by @larsoner in #916
- MAINT: Clean up namespace by @larsoner in #917
- Add Biotite to list of user projects by @padix-key in #919
- MAINT: Fix CIs by @larsoner in #920
- Ensures right builder conifg by @ExtremOPS in #922
- add GitHub URL for PyPi by @andriyor in #923
- Possibility to exclude implicit backreferences by @StefRe in #908
- [MRG] Handle nested structures by @alexisthual in #904
- MAINT: Use -nWT --keep-going on Azure by @larsoner in #924
- DOC: fix rst link syntax in changelog by @GaelVaroquaux in #925
- [MRG] Changelog regarding nested sections by @alexisthual in #926
- MAINT: Fix CIs by @larsoner in #932
- Fix typos by @kianmeng in #934
- FIX: Fix for dep by @larsoner in #938
- Add Apache TVM to user projects list by @guberti in #942
- Fix rendering of embedded URIs in Python notebooks by @guberti in #943
- Store API reference examples thumbnails in common div by @alexisthual in #946
- ENH: Better dark mode support by @larsoner in #948
- syntax error fix in sphinx_gallery.downloads by @photoniker in #951
- Add flag to ignore code blocks in Python source parser by @guberti in #941
- Improve Jupyter notebook converter's handling of code blocks by @guberti in #940
- Fix Tensorflow/Abseil compatibility by @guberti in #961
- Optional usage of
module
instead ofmodule_short
when doing backreferencing by @ExtremOPS in #950 - Merge toctrees containing subcategories indices and examples without … by @alexisthual in #944
- Avoid matplotlib warnings in seaborn reset_module by @lesteve in #969
- Fix typo by @tkoyama010 in #970
- add Tonic to list of sphinx-gallery users by @biphasic in #972
- Remove test examples for seaborn warning by @lesteve in #971
- BUG: Fix bug with clicking examples by @larsoner in #973
- added RADIS in Who uses Sphinx-gallery ? by @erwanp in #979
- BUG: Hotfix for docopts_url by @larsoner in #980
- MAINT: Bump to 0.11.0 by @larsoner in #981
New Contributors
- @ixjlyons made their first contribution in #883
- @StefRe made their first contribution in #890
- @alexisthual made their first contribution in #906
- @ExtremOPS made their first contribution in #922
- @andriyor made their first contribution in #923
- @kianmeng made their first contribution in #934
- @guberti made their first contribution in #942
- @photoniker made their first contribution in #951
- @tkoyama010 made their first contribution in #970
- @biphasic made their first contribution in #972
- @erwanp made their first contribution in #979
Full Changelog: v0.10.1...v0.11.0
Release v0.10.1
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
breakssphinx_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:
- DOC Add reference to sphinx-codeautolink #874 (felix-hilden)
- Add Neuraxle to "Who uses Sphinx-Gallery" #873 (guillaume-chevalier)
- DOC Fix typo in dummy images doc #871 (lucyleeow)
- CI: Fix CircleCI #865 (larsoner)