Merge branch 'main' into VGroup_type_subscripting

.github/workflows/ci.yml

@@ -23,15 +23,15 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-22.04, macos-13, windows-latest]
-        python: ["3.9", "3.10", "3.11", "3.12"]
+        python: ["3.9", "3.10", "3.11", "3.12", "3.13"]
 
     steps:
       - name: Checkout the repository
         uses: actions/checkout@v4
 
       - name: Install Poetry
         run: |
-          pipx install "poetry==1.7.*"
+          pipx install "poetry==1.8.*"
           poetry config virtualenvs.prefer-active-python true
 
       - name: Setup Python ${{ matrix.python }}
@@ -142,10 +142,7 @@ jobs:
           Expand-Archive -LiteralPath "$($env:TMP)\TinyTex.zip" -DestinationPath "$($PWD)\ManimCache\LatexWindows"
           $env:Path = "$($PWD)\ManimCache\LatexWindows\TinyTeX\bin\windows;$($env:PATH)"
           tlmgr update --self
-          foreach ($c in $tinyTexPackages){
-            $c=$c.Trim()
-            tlmgr install $c
-          }
+          tlmgr install $tinyTexPackages
           $env:PATH=$OriPath
           echo "Completed Latex"
 
@@ -156,10 +153,9 @@ jobs:
           $env:Path = "$env:USERPROFILE\.poetry\bin;$($env:PATH)"
           echo "$env:Path" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
 
-      - name: Install manim
+      - name: Install dependencies and manim
         run: |
-          poetry config installer.modern-installation false
-          poetry install
+          poetry install --all-extras
 
       - name: Run tests
         run: |

.github/workflows/publish-docker.yml

@@ -25,7 +25,7 @@ jobs:
           password: ${{ secrets.DOCKERHUB_TOKEN }}
 
       - name: Build and push
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         with:
           platforms: linux/arm64,linux/amd64
           push: true
@@ -61,7 +61,7 @@ jobs:
             print(f"tag_name={ref_tag}", file=f)
 
       - name: Build and push
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         with:
           platforms: linux/arm64,linux/amd64
           push: true

.pre-commit-config.yaml

@@ -1,9 +1,9 @@
-default_stages: [commit, push]
+default_stages: [pre-commit, pre-push]
 fail_fast: false
 exclude: ^(manim/grpc/gen/|docs/i18n/)
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v5.0.0
     hooks:
       - id: check-ast
         name: Validate Python
@@ -12,36 +12,17 @@ repos:
       - id: end-of-file-fixer
       - id: check-toml
         name: Validate Poetry
-  - repo: https://github.com/pre-commit/pygrep-hooks
-    rev: v1.10.0
-    hooks:
-      - id: python-check-blanket-noqa
-        name: Precision flake ignores
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.4.10
+    rev: v0.8.0
     hooks:
       - id: ruff
         name: ruff lint
         types: [python]
         args: [--exit-non-zero-on-fix]
       - id: ruff-format
         types: [python]
-  - repo: https://github.com/PyCQA/flake8
-    rev: 7.1.0
-    hooks:
-      - id: flake8
-        additional_dependencies:
-          [
-            flake8-bugbear==21.4.3,
-            flake8-builtins==1.5.3,
-            flake8-comprehensions>=3.6.1,
-            flake8-docstrings==1.6.0,
-            flake8-pytest-style==1.5.0,
-            flake8-rst-docstrings==0.2.3,
-            flake8-simplify==0.14.1,
-          ]
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.10.0
+    rev: v1.13.0
     hooks:
       - id: mypy
         additional_dependencies:

README.md

@@ -21,7 +21,8 @@
 
 Manim is an animation engine for explanatory math videos. It's used to create precise animations programmatically, as demonstrated in the videos of [3Blue1Brown](https://www.3blue1brown.com/).
 
-> NOTE: This repository is maintained by the Manim Community and is not associated with Grant Sanderson or 3Blue1Brown in any way (although we are definitely indebted to him for providing his work to the world). If you would like to study how Grant makes his videos, head over to his repository ([3b1b/manim](https://github.com/3b1b/manim)). This fork is updated more frequently than his, and it's recommended to use this fork if you'd like to use Manim for your own projects.
+> [!NOTE]
+> This repository is maintained by the Manim Community and is not associated with Grant Sanderson or 3Blue1Brown in any way (although we are definitely indebted to him for providing his work to the world). If you would like to study how Grant makes his videos, head over to his repository ([3b1b/manim](https://github.com/3b1b/manim)). This fork is updated more frequently than his, and it's recommended to use this fork if you'd like to use Manim for your own projects.
 
 ## Table of Contents:
 
@@ -35,7 +36,8 @@ Manim is an animation engine for explanatory math videos. It's used to create pr
 
 ## Installation
 
-> **WARNING:** These instructions are for the community version _only_. Trying to use these instructions to install [3b1b/manim](https://github.com/3b1b/manim) or instructions there to install this version will cause problems. Read [this](https://docs.manim.community/en/stable/faq/installation.html#why-are-there-different-versions-of-manim) and decide which version you wish to install, then only follow the instructions for your desired version.
+> [!CAUTION]
+> These instructions are for the community version _only_. Trying to use these instructions to install [3b1b/manim](https://github.com/3b1b/manim) or instructions there to install this version will cause problems. Read [this](https://docs.manim.community/en/stable/faq/installation.html#why-are-there-different-versions-of-manim) and decide which version you wish to install, then only follow the instructions for your desired version.
 
 Manim requires a few dependencies that must be installed prior to using it. If you
 want to try it out first before installing it locally, you can do so

docker/Dockerfile

@@ -22,9 +22,9 @@ RUN wget -O /tmp/install-tl-unx.tar.gz http://mirror.ctan.org/systems/texlive/tl
     tar -xzf /tmp/install-tl-unx.tar.gz -C /tmp/install-tl --strip-components=1 && \
     /tmp/install-tl/install-tl --profile=/tmp/texlive-profile.txt \
     && tlmgr install \
-        amsmath babel-english cbfonts-fd cm-super ctex doublestroke dvisvgm everysel \
+        amsmath babel-english cbfonts-fd cm-super count1to ctex doublestroke dvisvgm everysel \
         fontspec frcursive fundus-calligra gnu-freefont jknapltx latex-bin \
-        mathastext microtype ms physics preview ragged2e relsize rsfs \
+        mathastext microtype multitoc physics prelim2e preview ragged2e relsize rsfs \
         setspace standalone tipa wasy wasysym xcolor xetex xkeyval
 
 # clone and build manim
@@ -36,9 +36,9 @@ RUN pip install -r docs/requirements.txt
 
 ARG NB_USER=manimuser
 ARG NB_UID=1000
-ENV USER ${NB_USER}
-ENV NB_UID ${NB_UID}
-ENV HOME /manim
+ENV USER=${NB_USER}
+ENV NB_UID=${NB_UID}
+ENV HOME=/manim
 
 RUN adduser --disabled-password \
     --gecos "Default user" \

docs/requirements.txt

@@ -3,3 +3,5 @@ myst-parser
 sphinx>=7.3
 sphinx-copybutton
 sphinxext-opengraph
+sphinx-design
+sphinx-reredirects

docs/source/conf.py

@@ -26,7 +26,7 @@
 # -- Project information -----------------------------------------------------
 
 project = "Manim"
-copyright = f"2020-{datetime.now().year}, The Manim Community Dev Team"
+copyright = f"2020-{datetime.now().year}, The Manim Community Dev Team"  # noqa: A001
 author = "The Manim Community Dev Team"
 
 
@@ -51,19 +51,30 @@
     "sphinx.ext.inheritance_diagram",
     "sphinxcontrib.programoutput",
     "myst_parser",
+    "sphinx_design",
+    "sphinx_reredirects",
 ]
 
 # Automatically generate stub pages when using the .. autosummary directive
 autosummary_generate = True
 
+myst_enable_extensions = ["colon_fence", "amsmath"]
+
+# redirects (for moved / deleted pages)
+redirects = {
+    "installation/linux": "uv.html",
+    "installation/macos": "uv.html",
+    "installation/windows": "uv.html",
+}
+
 # generate documentation from type hints
 ALIAS_DOCS_DICT = parse_module_attributes()[0]
 autodoc_typehints = "description"
 autodoc_type_aliases = {
     alias_name: f"~manim.{module}.{alias_name}"
     for module, module_dict in ALIAS_DOCS_DICT.items()
     for category_dict in module_dict.values()
-    for alias_name in category_dict.keys()
+    for alias_name in category_dict
 }
 autoclass_content = "both"
 

docs/source/contributing/docs/types.rst

@@ -57,7 +57,8 @@ consider this slightly contrived function:
 
 .. code-block:: python
 
-   def shift_mobject(mob: Mobject, direction: Vector3D, scale_factor: float = 1) -> mob:
+   M = TypeVar("M", bound=Mobject)  # allow any mobject
+   def shift_mobject(mob: M, direction: Vector3D, scale_factor: float = 1) -> M:
        return mob.shift(direction * scale_factor)
 
 Here we see an important example of the difference. ``direction`` can not, and
@@ -129,6 +130,6 @@ There are several representations of images in Manim. The most common is
 the representation as a NumPy array of floats representing the pixels of an image.
 This is especially common when it comes to the OpenGL renderer.
 
-This is the use case of the :class:`~.typing.Image` type hint. Sometimes, Manim may use ``PIL.Image``,
-in which case one should use that type hint instead.
+This is the use case of the :class:`~.typing.PixelArray` type hint. Sometimes, Manim may use ``PIL.Image.Image``,
+which is not the same as :class:`~.typing.PixelArray`. In this case, use the ``PIL.Image.Image`` typehint.
 Of course, if a more specific type of image is needed, it can be annotated as such.

docs/source/examples.rst

@@ -90,7 +90,7 @@ Basic Concepts
                 [[i * 256 / n for i in range(0, n)] for _ in range(0, n)]
             )
             image = ImageMobject(imageArray).scale(2)
-            image.background_rectangle = SurroundingRectangle(image, GREEN)
+            image.background_rectangle = SurroundingRectangle(image, color=GREEN)
             self.add(image, image.background_rectangle)
 
 .. manim:: BooleanOperations

docs/source/faq/installation.md

@@ -120,19 +120,24 @@ of [ManimPango's README](https://github.com/ManimCommunity/ManimPango).
 
 ---
 
+(not-on-path)=
 ## I am using Windows and get the error `X is not recognized as an internal or external command, operable program or batch file`
 
-Regardless of whether `X` says `python` or `manim`, this means that the executable you
-are trying to run is not located in one of the directories your system is looking
-for them (specified by the `PATH` variable). Take a look at the instructions
-{doc}`in the installation guide for Windows </installation/windows>`, or
-[this StackExchange answer](https://superuser.com/questions/143119/how-do-i-add-python-to-the-windows-path/143121#143121)
-to get help with editing the `PATH` variable manually.
+If you have followed {doc}`our local installation instructions </installation/uv>` and
+have not activated the corresponding virtual environment, make sure to use `uv run manim ...`
+instead of just `manim` (or activate the virtual environment by following the instructions
+printed when running `uv venv`).
 
-If `python` is recognized but not `manim` or `pip`, you can try running
+Otherwise there is a problem with the directories where your system is looking for
+executables (the `PATH` variable).
+If `python` is recognized, you can try running
 commands by prepending `python -m`. That is, `manim` becomes `python -m manim`,
 and `pip` becomes `python -m pip`.
 
+Otherwise see
+[this StackExchange answer](https://superuser.com/questions/143119/how-do-i-add-python-to-the-windows-path/143121#143121)
+to get help with editing the `PATH` variable manually.
+
 ---
 
 ## I have tried using Chocolatey (`choco install manimce`) to install Manim, but it failed!