From d656354047ec529402d28b90a91fe1c8d8a7dfad Mon Sep 17 00:00:00 2001 From: fanchengyan Date: Mon, 19 Aug 2024 15:51:41 +0800 Subject: [PATCH] update change log --- docs/source/changelog/index.rst | 1 + docs/source/changelog/v0.2.2.rst | 34 ++++++++++++++++++++++++++++++++ pyproject.toml | 4 +++- 3 files changed, 38 insertions(+), 1 deletion(-) create mode 100644 docs/source/changelog/v0.2.2.rst diff --git a/docs/source/changelog/index.rst b/docs/source/changelog/index.rst index 30d187b..0fea4c4 100644 --- a/docs/source/changelog/index.rst +++ b/docs/source/changelog/index.rst @@ -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 diff --git a/docs/source/changelog/v0.2.2.rst b/docs/source/changelog/v0.2.2.rst new file mode 100644 index 0000000..f1a6a2c --- /dev/null +++ b/docs/source/changelog/v0.2.2.rst @@ -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. diff --git a/pyproject.toml b/pyproject.toml index 869177b..7e10af9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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"] @@ -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