Sphinx extension for automatic generation of an example gallery
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:
Fixed bugs:
UnicodeDecodeError
in recommender #1244 (Charlie-XIAO)Documentation
image_srcset
config in scraper section in advanced.rst
#1280 (lucyleeow)True
for docs #1263 (lucyleeow)Project maintenance
test_fileno
#1287 (lucyleeow)image_srcset
#1278 (lucyleeow)pyproject.toml
#1267 (Borda)sphinx-lint
for Sphinx extension #1266 (Borda)install.sh
with used job #1265 (Borda)maintainers.rst
#1234 (lucyleeow)Support for Python 3.7 dropped in this release. Requirement is now Python >=3.8. Pillow added as a dependency.
Implemented enhancements:
Fixed bugs:
Documentation
Project maintenance
extras_require
in setup.py
#1229 (lucyleeow)Implemented enhancements:
Fixed bugs:
app.builder.outdir
as Sphinx now using pathlib #1155 (lucyleeow)Documentation
_get_docstring_and_rest
docstring #1182 (lucyleeow)configuration.rst
#1181 (lucyleeow)Project maintenance
test_identify_names
so class property tested #1180 (lucyleeow)figure_rst
path testing to own unit test #1173 (lucyleeow)test_figure_rst_srcset
#1172 (lucyleeow)_embed_code_links
#1157 (lucyleeow)* This Changelog was automatically generated by github_changelog_generator
Implemented enhancements:
Fixed bugs:
API changes
Documentation
Project maintenance
Fixed bugs:
Fixed bugs:
sphinx_gallery_conf
in python_to_jupyter_cli
by @OverLordGoldDragon in https://github.com/sphinx-gallery/sphinx-gallery/pull/1027
subsection_index_toctree
referenced before assignment" by @OverLordGoldDragon in https://github.com/sphinx-gallery/sphinx-gallery/pull/1035
plot_gallery
as a string by default by @melissawm in https://github.com/sphinx-gallery/sphinx-gallery/pull/1062
Full Changelog: https://github.com/sphinx-gallery/sphinx-gallery/compare/v0.11.1...v0.12.0
Full Changelog: https://github.com/sphinx-gallery/sphinx-gallery/compare/v0.11.0...v0.11.1
module
instead of module_short
when doing backreferencing by @ExtremOPS in https://github.com/sphinx-gallery/sphinx-gallery/pull/950
Full Changelog: https://github.com/sphinx-gallery/sphinx-gallery/compare/v0.10.1...v0.11.0
Support for Python 3.6 dropped in this release. Requirement is Python >=3.7.
Implemented enhancements:
reset_modules
to be applied after each or all examples #866
reset_modules
to run either before or after examples, or both #870 (MatthewFlamm)Fixed bugs:
0.10.0
breaks sphinx_gallery.load_style
#878
Closed issues:
.rst
sphinx build but not inside example generated with sphinx-gallery #868
Merged pull requests: