Skip to content

Commit fbf5f42

Browse files
committed
Merge branch 'main' into reorganize
2 parents 3c8384a + 0c6cd67 commit fbf5f42

File tree

13 files changed

+212
-135
lines changed

13 files changed

+212
-135
lines changed

.github/workflows/tests.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ jobs:
9696
uses: ssciwr/setup-mesa-dist-win@v2
9797

9898
- name: Run pytest
99-
run: uv run --python ${{ matrix.pyversion }} --frozen --extra tests pytest
99+
run: uv run --python ${{ matrix.pyversion }} --frozen --group tests --no-dev pytest
100100

101101
- name: Upload to codecov.io
102102
uses: codecov/codecov-action@v5

.pre-commit-config.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,18 @@ repos:
2121
exclude: poetry.lock
2222
args: [--autofix, --trailing-commas]
2323
- repo: https://github.com/astral-sh/ruff-pre-commit
24-
rev: v0.9.3
24+
rev: v0.11.5
2525
hooks:
2626
- id: ruff
2727
args: [--fix]
2828
- id: ruff-format
2929
- repo: https://github.com/pre-commit/mirrors-mypy
30-
rev: v1.14.1
30+
rev: v1.15.0
3131
hooks:
3232
- id: mypy
3333
additional_dependencies: [types-requests, types-setuptools]
3434
- repo: https://github.com/codespell-project/codespell
35-
rev: v2.4.0
35+
rev: v2.4.1
3636
hooks:
3737
- id: codespell
3838
additional_dependencies:

.readthedocs.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ build:
66
apt_packages:
77
- libpango1.0-dev
88
- ffmpeg
9+
jobs:
10+
post_create_environment:
11+
- asdf plugin add uv
12+
- asdf install uv latest
13+
- asdf global uv latest
14+
- UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --group docs --no-dev --no-cache
915
sphinx:
1016
builder: html
1117
configuration: docs/source/conf.py
1218
fail_on_warning: true
13-
python:
14-
install:
15-
- method: pip
16-
path: .
17-
extra_requirements:
18-
- docs

CHANGELOG.md

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,36 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
88
<!-- start changelog -->
99

1010
(unreleased)=
11-
## [Unreleased](https://github.com/jeertmans/manim-slides/compare/v5.4.2...HEAD)
11+
## [Unreleased](https://github.com/jeertmans/manim-slides/compare/v5.5.1...HEAD)
1212

13-
(unreleased-added)=
13+
(unreleased-chore)=
14+
### Chore
15+
16+
- Moved `docs` and `tests` extras, as well as `dev-dependencies`,
17+
inside groups in `dependency-groups`. This could break existing code
18+
when using one of those extras, but as they were not part of the public API,
19+
we do not consider this to be a **breaking change**.
20+
[#542](https://github.com/jeertmans/manim-slides/pull/542)
21+
22+
(v5.5.1)=
23+
## [v5.5.1](https://github.com/jeertmans/manim-slides/compare/v5.5.0...v5.5.1)
24+
25+
(v5.5.1-changed)=
26+
### Changed
27+
28+
- HTML template now always includes the *notes* plugin so that the speaker
29+
view is always available. Previously, it was only included if the slides
30+
had notes.
31+
[#538](https://github.com/jeertmans/manim-slides/pull/538)
32+
- Pressing <kbd>SPACE</kbd> key now pauses the slides, instead of skipping it.
33+
Previously, it was not possible to pause HTML slides, which can be very annoying
34+
when trying to explain something.
35+
[#539](https://github.com/jeertmans/manim-slides/pull/539)
36+
37+
(v5.5.0)=
38+
## [v5.5.0](https://github.com/jeertmans/manim-slides/compare/v5.4.2...v5.5.0)
39+
40+
(v5.5.0-added)=
1441
### Added
1542

1643
- Added `max_duration_before_split_reverse` and `num_processes` class variables.
@@ -19,18 +46,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1946
videos as slides.
2047
[#526](https://github.com/jeertmans/manim-slides/pull/526)
2148

22-
(unreleased-changed)=
49+
(v5.5.0-changed)=
2350
### Changed
2451

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

29-
(unreleased-chore)=
56+
(v5.5.0-chore)=
3057
### Chore
3158

3259
- Trimmed whitespaces in HTML template.
3360
[#443](https://github.com/jeertmans/manim-slides/pull/443)
61+
- Bumped RevealJS' version to 5.2 to allow video playing in speaker view.
62+
[#536](https://github.com/jeertmans/manim-slides/pull/536)
3463

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

CITATION.cff

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@
44
cff-version: 1.2.0
55
title: Manim Slides
66
message: >-
7-
If you use this software, please cite it using the
8-
metadata from this file.
7+
If you use this software, please cite it using our article
8+
in the Journal of Open Source Education.
99
type: software
1010
authors:
1111
- name: Jérome Eertmans
1212
orcid: 'https://orcid.org/0000-0002-5579-5360'
1313
website: 'https://eertmans.be'
14+
doi: 10.5281/zenodo.7971360
1415
repository-code: 'https://github.com/jeertmans/manim-slides'
1516
url: 'https://eertmans.be/manim-slides'
1617
abstract: >-
@@ -26,7 +27,7 @@ keywords:
2627
- PowerPoint
2728
- Python
2829
license: MIT
29-
version: v5.4.2
30+
version: v5.5.1
3031
preferred-citation:
3132
publisher:
3233
name: The Open Journal

README.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
> [!IMPORTANT]
2-
> Take the [**Manim Slides Survey**](https://forms.gle/i4scrwPQghbTQwQs5)
3-
> to help improve this tool! Thanks in advance to all the people taking the time
4-
> to answer this short survey! The form is open until **January 31st 2025**,
5-
> and results will be communicated in the GitHub discussions.
6-
71
<picture>
82
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/logo_dark_transparent.png">
93
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/logo_light_transparent.png">
@@ -234,8 +228,8 @@ you can do so at: [jeertmans@icloud.com](mailto:jeertmans@icloud.com).
234228
[pypi-download-badge]: https://img.shields.io/pypi/dm/manim-slides
235229
[documentation-badge]: https://readthedocs.org/projects/manim-slides/badge/?version=latest
236230
[documentation-url]: https://manim-slides.readthedocs.io/
237-
[doi-badge]: https://zenodo.org/badge/DOI/10.5281/zenodo.8215167.svg
238-
[doi-url]: https://doi.org/10.5281/zenodo.8215167
231+
[doi-badge]: https://zenodo.org/badge/DOI/10.5281/zenodo.7971360.svg
232+
[doi-url]: https://doi.org/10.5281/zenodo.7971360
239233
[jose-badge]: https://jose.theoj.org/papers/10.21105/jose.00206/status.svg
240234
[jose-url]: https://doi.org/10.21105/jose.00206
241235
[codecov-badge]: https://codecov.io/gh/jeertmans/manim-slides/branch/main/graph/badge.svg?token=8P4DY9JCE4

docs/source/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
# For the full list of built-in configuration values, see the documentation:
55
# https://www.sphinx-doc.org/en/master/usage/configuration.html
66

7+
import os
78
import sys
89
from datetime import date
910

@@ -55,6 +56,7 @@
5556
# -- Options for HTML output -------------------------------------------------
5657
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
5758

59+
html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "/")
5860
html_theme = "furo"
5961
html_static_path = ["_static"]
6062
html_favicon = "_static/favicon.png"

docs/source/contributing/workflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ and development dependencies. If not already, please install this tool.
3232
With uv, installation becomes straightforward:
3333

3434
```bash
35-
uv sync --all-extras
35+
uv sync
3636
```
3737

3838
:::{note}

docs/source/features_table.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,22 @@ The following summarizes the different presentation features Manim Slides offers
1010
| :--- | :---: | :---: | :---: | :---: |
1111
| Basic navigation through slides | Yes | Yes | Yes | Yes (static image) |
1212
| Replay slide | Yes | No | No | N/A |
13-
| Pause animation | Yes | No | No | N/A |
13+
| Pause animation | Yes | Yes | No | N/A |
1414
| Play slide in reverse | Yes | No | No | N/A |
1515
| Slide count | Yes | Yes (optional) | Yes (optional) | N/A |
1616
| Needs Python with Manim Slides installed | Yes | No | No | No
17-
| Requires internet access | No | Yes | No | No |
17+
| Requires internet access | No | Depends[^1] | No | No |
1818
| Auto. play slides | Yes | Yes | Yes | N/A |
1919
| Loops support | Yes | Yes | Yes | N/A |
2020
| Fully customizable | No | Yes (`--use-template` option) | No | No |
21-
| Other dependencies | None | A modern web browser | PowerPoint or LibreOffice Impress[^1] | None |
22-
| Works cross-platforms | Yes | Yes | Partly[^1][^2] | Yes |
21+
| Other dependencies | None | A modern web browser | PowerPoint or LibreOffice Impress[^2] | None |
22+
| Works cross-platforms | Yes | Yes | Partly[^2][^3] | Yes |
2323
:::
2424

25-
[^1]: If you encounter a problem where slides do not automatically play or loops do not work,
25+
[^1]: By default, HTML assets are loaded from the internet, but they can be
26+
pre-downloaded and embedded in the HTML file at conversion time.
27+
[^2]: If you encounter a problem where slides do not automatically play or loops do not work,
2628
please
2729
[file an issue on GitHub](https://github.com/jeertmans/manim-slides/issues/new/choose).
28-
[^2]: PowerPoint online does not seem to support automatic playing of videos,
30+
[^3]: PowerPoint online does not seem to support automatic playing of videos,
2931
so you need LibreOffice Impress on Linux platforms.

manim_slides/cli/convert/commands.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -536,7 +536,7 @@ class RevealJS(Converter):
536536
"black",
537537
description="Background color used in slides, not relevant if videos fill the whole area.",
538538
)
539-
reveal_version: str = Field("5.1.0", description="RevealJS version.")
539+
reveal_version: str = Field("5.2.0", description="RevealJS version.")
540540
reveal_theme: RevealTheme = Field(
541541
RevealTheme.black, description="RevealJS version."
542542
)

0 commit comments

Comments
 (0)