Releases: smarie/mkdocs-gallery
Releases · smarie/mkdocs-gallery
0.7.7 - Bugfixes and new python versions
- Official support for python 3.10 and 3.11. PR #52 by GenevieveBuckley
- Fixed
AttributeError: MySubConfig has no '_pre_validate'
withmkdocs
version1.4
or greater. Fixes #57
See documentation page for details.
0.7.6 - Bugfixes
- Fixed incorrect img
srcset
paths leading to figures not being displayed in gallery examples. Fixes #47 - Fixed
TypeError: startswith first arg must be str or a tuple of str, not WindowsPath
when running withmkdocs serve
. Fixes #45. PR #46 by mchaaler.
See documentation page for details.
0.7.5 - Bugfixes
- Examples expected to fail are now correctly skipped in case of identical md5 hash, too. Fixes #34. PR #39 by mchaaler.
See documentation page for details.
0.7.3 - Bugfix
matplotlib
was still not optional by default because of the associatedimage_scraper
that was called even when not used. It is now truly optional. Fixed #24
See documentation page for details.
0.7.2 - Misc. bug fixes and improvements
- Fixed
KeyError
issue when using a minimalistic configuration. Fixed #22. matplotlib
is now optional. Fixed #24
See documentation page for details.
0.7.1 - Packaging is now correct
- Fixed packaging issue: static resources were not included in wheel. Adopted
src/
layout. Fixed #19.
See documentation page for details.
0.7.0 - Code output max height + updated one example
- Code output now have a correct height limit. Fixed #7
- Fixed the "Notebook Style Example" tutorial. Fixed #17
See documentation page for details.
0.6.0 - All examples + Edit page link + Binder badges !
- Completed the gallery of examples. Fixed #1
- Fixed HTML repr (example 2, typically used to display pandas tables). Fixed #11
- Binder badges now work correctly. Fixes #5
- "Edit page" links (pencil icon at the top) now work as expected: they take the user to the source python file used to generate the page. It also works for gallery readme pages ! Fixes #8
- backreferences files are now written but it is still not clear how they should be used in a mkdocs context, see #10
- Fixed most flake8 issues and warnings.
See documentation page for details.
0.5.0 - First public working release
Initial release with:
-
Basic features:
- pages generation with markdown-based gallery examples. Currently only the
material
theme renders correctly - download buttons (both on each example and on the summaries) and page header link to the downloads section
- subgalleries
- gallery synthesis with proper icons and subgalleries
- auto inclusion in the ToC (nav) with support for the section index pages feature
- working
mkdocs serve
: correctly ignoring generated files to avoid infinite build loop - working
mkdocs.yml
configuration for most options - New option
conf_script
to configure via a script as in Sphinx-gallery.
- pages generation with markdown-based gallery examples. Currently only the
-
All gallery examples from Sphinx-Gallery successfully translated, in particular:
- LaTeX support works
-
Refactoring:
- Using pathlib all over the place
- Using f-string whenever possible
- Object-oriented approach for configuration and dir/file names used in the generated files.
See documentation page for details.