Skip to content

Commit

Permalink
update change log
Browse files Browse the repository at this point in the history
  • Loading branch information
Fanchengyan committed Aug 19, 2024
1 parent 44e0be4 commit d656354
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/source/changelog/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@ This is the list of changes to MyST Sphinx Gallery between each release. For ful
.. toctree::
:maxdepth: 2

v0.2.2
v0.2.1
v0.2.0
34 changes: 34 additions & 0 deletions docs/source/changelog/v0.2.2.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
==================================
What’s new in 0.2.2 (Aug 19, 2024)
==================================

Enhancements
------------

Thumbnails
^^^^^^^^^^


- :class:`~myst_sphinx_gallery.ThumbnailConfig` now supports a new option:
``max_animation_frames``, to control the maximum number of frames for the
animated thumbnail. This option is useful when the animation has too many
frames, saving storage space and building time.
- ``quality_animated`` changed from ``15`` to ``50`` to improve the quality of
the animation thumbnail. This change will not increase the animated
thumbnail file size since frames are reduced by the
``max_animation_frames`` option.


Cross-referencing
^^^^^^^^^^^^^^^^^

- the target of ``GALLERY_HEADER.rst`` now will be added a suffix ``_header``
to avoid conflict with the example files.

Runtime
^^^^^^^

Now, the runtime of building the gallery will be displayed in the console
output. This feature is useful when you want to know how long it takes to
build the gallery and optimize the building time by changing the configuration
options of thumbnails.
4 changes: 3 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,8 @@ markers = [
"slow: marks tests as slow",
]

[tool.ruff]
line-length = 88

[tool.ruff.lint]
select = ["E", "F", "I", "SIM", "B", "UP"]
Expand All @@ -120,7 +122,7 @@ ignore = ["F401", "E501"]
[tool.ruff.format]
docstring-code-format = true


[tool.doc8]
ignore = ["D001"]
allow-long-titles = true
max-line-length=88

0 comments on commit d656354

Please sign in to comment.