Skip to content

Commit

Permalink
chore(docs): fix docs and add changelog entry
Browse files Browse the repository at this point in the history
  • Loading branch information
jeertmans committed Jan 28, 2025
1 parent 6d4fe1b commit ea1293a
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 12 deletions.
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
(unreleased)=
## [Unreleased](https://github.com/jeertmans/manim-slides/compare/v5.4.2...HEAD)

(unreleased-added)=
### Added

- Added `max_duration_before_split_reverse` and `num_processes` class variables.
[#439](https://github.com/jeertmans/manim-slides/pull/439)

(unreleased-changed)=
### Changed

- Automatically split large video animations into smaller chunks
for lightweight (and potentially faster) reversed animations generation.
[#439](https://github.com/jeertmans/manim-slides/pull/439)

(v5.4.2)=
## [v5.4.2](https://github.com/jeertmans/manim-slides/compare/v5.4.1...v5.4.2)

Expand Down
17 changes: 5 additions & 12 deletions manim_slides/slide/manim.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,31 +20,24 @@ class Slide(BaseSlide, Scene): # type: ignore[misc]
:cvar bool disable_caching: :data:`False`: Whether to disable the use of
cached animation files.
:cvar bool flush_cache: :data:`False`: Whether to flush the cache.
Unlike with Manim, flushing is performed before rendering.
:cvar bool skip_reversing: :data:`False`: Whether to generate reversed animations.
If set to :data:`False`, and no cached reversed animation
exists (or caching is disabled) for a given slide,
then the reversed animation will be simply the same
as the original one, i.e., ``rev_file = file``,
for the current slide config.
:cvar float|None max_duration_before_split_reverse: :data:`4.0`:
Maximum duration before of a video animation before it is
reversed by splitting the file into smaller chunks.
:cvar typing.Optional[float] max_duration_before_split_reverse: :data:`4.0`: Maximum duration
before of a video animation before it is reversed by splitting the file into smaller chunks.
Generating reversed animations can require an important amount of
memory (because the whole video needs to be kept in memory),
and splitting the video into multiple chunks usually speeds
up the process (because it can be done in parallel) while taking
less memory.
Set this to :data:`None` to disable splitting the file into chunks.
:cvar int|None num_processes :data:`None`:
Number of processes to use for parallelizable operations.
Defaults to :data:`None`, the number of available logical processes.
:cvar typing.Optional[int] num_processes: :data:`None`: Number of processes
to use for parallelizable operations.
If :data:`None`, defaults to :func:`os.process_cpu_count`.
This is currently used when generating reversed animations, and can
increase memory consumption.
"""
Expand Down

0 comments on commit ea1293a

Please sign in to comment.