Merge branch 'main' of https://github.com/ManimCommunity/manim into g…

…uide

.codespell_ignorewords

@@ -0,0 +1,5 @@
+ nam
+ sherif
+ falsy
+ medias
+ strager

.codespellrc

@@ -1,4 +1,4 @@
 [codespell]
-exclude-file=.codespell_ignorelines
-check-hidden=True
-ignore-words-list = nam,sherif,falsy
+check-hidden = True
+skip = .git,*.js,*.js.map,*.css,*.css.map,*.html,*.po,*.pot,poetry.lock,*.log,*.svg
+ignore-words = .codespell_ignorewords

.flake8

@@ -2,7 +2,7 @@
 # Exclude the grpc generated code
 exclude = ./manim/grpc/gen/*, __pycache__,.git,
 per-file-ignores = __init__.py:F401
-max-complexity = 15
+max-complexity = 29
 max-line-length = 88
 statistics = True
 # Prevents some flake8-rst-docstrings errors
@@ -18,6 +18,9 @@ extend-ignore = E203, W503, D202, D212, D213, D404
                 # Misc
                 F401, F403, F405, F841, E501, E731, E402, F811, F821,
 
+                # multiple statements on one line (overload)
+                E704,
+
                 # Plug-in: flake8-builtins
                 A001, A002, A003,
 
@@ -27,9 +30,6 @@ extend-ignore = E203, W503, D202, D212, D213, D404
                 # Plug-in: flake8-simplify
                 SIM105, SIM106, SIM119,
 
-                # Plug-in: flake8-comprehensions
-                C901
-
                 # Plug-in: flake8-pytest-style
                 PT001, PT004, PT006, PT011, PT018, PT022, PT023,
 

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# Switched to ruff format:
+24025b60d57301b0a59754c38d77bccd8ed69feb

.github/ISSUE_TEMPLATE/bug_report.md

@@ -70,14 +70,5 @@ PASTE HERE
 <!-- output of `tlmgr list --only-installed` for TeX Live or a screenshot of the Packages page for MikTeX -->
 </details>
 
-<details><summary>FFMPEG</summary>
-
-Output of `ffmpeg -version`:
-
-```
-PASTE HERE
-```
-</details>
-
 ## Additional comments
 <!-- Add further context that you think might be relevant for this issue here. -->

.github/ISSUE_TEMPLATE/installation_issue.md

@@ -53,14 +53,5 @@ PASTE HERE
 <!-- output of `tlmgr list --only-installed` for TeX Live or a screenshot of the Packages page for MikTeX -->
 </details>
 
-<details><summary>FFMPEG</summary>
-
-Output of `ffmpeg -version`:
-
-```
-PASTE HERE
-```
-</details>
-
 ## Additional comments
 <!-- Add further context that you think might be relevant for this issue here. -->

.github/manimdependency.json

@@ -4,7 +4,10 @@
             "standalone",
             "preview",
             "doublestroke",
-            "ms",
+            "count1to",
+            "multitoc",
+            "prelim2e",
+            "ragged2e",
             "everysel",
             "setspace",
             "rsfs",
@@ -29,7 +32,10 @@
             "standalone",
             "preview",
             "doublestroke",
-            "ms",
+            "count1to",
+            "multitoc",
+            "prelim2e",
+            "ragged2e",
             "everysel",
             "setspace",
             "rsfs",

.github/workflows/ci.yml

@@ -18,10 +18,11 @@ jobs:
     env:
       DISPLAY: :0
       PYTEST_ADDOPTS: "--color=yes" # colors in pytest
+      PYTHONIOENCODING: "utf8"
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-22.04, macos-latest, windows-latest]
+        os: [ubuntu-22.04, macos-13, windows-latest]
         python: ["3.9", "3.10", "3.11", "3.12"]
 
     steps:
@@ -50,12 +51,6 @@ jobs:
         run: |
           echo "date=$(/bin/date -u "+%m%w%Y")" >> $GITHUB_OUTPUT
 
-      - name: Install and cache ffmpeg (all OS)
-        uses: FedericoCarboni/setup-ffmpeg@v2
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-        id: setup-ffmpeg
-
       - name: Install system dependencies (Linux)
         if: runner.os == 'Linux'
         uses: awalsh128/cache-apt-pkgs-action@latest
@@ -77,7 +72,7 @@ jobs:
           sudo /usr/bin/Xvfb $DISPLAY -screen 0 1280x1024x24 &
 
       - name: Setup Cairo Cache
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         id: cache-cairo
         if: runner.os == 'Linux' || runner.os == 'macOS'
         with:
@@ -93,7 +88,7 @@ jobs:
         run: python .github/scripts/ci_build_cairo.py --set-env-vars
 
       - name: Setup macOS cache
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         id: cache-macos
         if: runner.os == 'macOS'
         with:
@@ -130,12 +125,12 @@ jobs:
       - name: Setup Windows cache
         id: cache-windows
         if: runner.os == 'Windows'
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ${{ github.workspace }}\ManimCache
           key: ${{ runner.os }}-dependencies-tinytex-${{ hashFiles('.github/manimdependency.json') }}-${{ steps.cache-vars.outputs.date }}-1
 
-      - uses: ssciwr/setup-mesa-dist-win@v1
+      - uses: ssciwr/setup-mesa-dist-win@v2
 
       - name: Install system dependencies (Windows)
         if: runner.os == 'Windows' && steps.cache-windows.outputs.cache-hit != 'true'

.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

.github/workflows/release-publish-documentation.yml

@@ -19,12 +19,13 @@ jobs:
     - name: Install system dependencies
       run: |
         sudo apt update && sudo apt install -y \
-          pkg-config libcairo-dev libpango1.0-dev ffmpeg wget fonts-roboto
+          pkg-config libcairo-dev libpango1.0-dev wget fonts-roboto
         wget -qO- "https://yihui.org/tinytex/install-bin-unix.sh" | sh
         echo ${HOME}/.TinyTeX/bin/x86_64-linux >> $GITHUB_PATH
 
     - name: Install LaTeX and Python dependencies
       run: |
+        tlmgr update --self
         tlmgr install \
           babel-english ctex doublestroke dvisvgm frcursive fundus-calligra jknapltx \
           mathastext microtype physics preview ragged2e relsize rsfs setspace standalone \

.pre-commit-config.yaml

@@ -3,7 +3,7 @@ fail_fast: false
 exclude: ^(manim/grpc/gen/|docs/i18n/)
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.6.0
     hooks:
       - id: check-ast
         name: Validate Python
@@ -12,39 +12,22 @@ repos:
       - id: end-of-file-fixer
       - id: check-toml
         name: Validate Poetry
-  - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
-    hooks:
-      - id: isort
-        name: isort (python)
-      - id: isort
-        name: isort (cython)
-        types: [cython]
-      - id: isort
-        name: isort (pyi)
-        types: [pyi]
-  - repo: https://github.com/asottile/pyupgrade
-    rev: v3.10.1
-    hooks:
-      - id: pyupgrade
-        name: Update code to new python versions
-        args: [--py37-plus]
   - 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/psf/black
-    rev: 23.7.0
-    hooks:
-      - id: black
-  - repo: https://github.com/asottile/blacken-docs
-    rev: 1.15.0
-    hooks:
-      - id: blacken-docs
-        additional_dependencies: [black==22.3.0]
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.5.1
+    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: 6.1.0
+    rev: 7.1.0
     hooks:
       - id: flake8
         additional_dependencies:
@@ -58,7 +41,7 @@ repos:
             flake8-simplify==0.14.1,
           ]
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.5.1
+    rev: v1.10.1
     hooks:
       - id: mypy
         additional_dependencies:
@@ -72,7 +55,7 @@ repos:
         files: ^manim/
 
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.5
+    rev: v2.3.0
     hooks:
       - id: codespell
         files: ^.*\.(py|md|rst)$

.readthedocs.yml

@@ -7,7 +7,6 @@ build:
 
   apt_packages:
     - libpango1.0-dev
-    - ffmpeg
     - graphviz
 
 python:

CITATION.cff

@@ -4,10 +4,10 @@ authors:
   -
     name: "The Manim Community Developers"
 cff-version: "1.2.0"
-date-released: 2023-11-11
+date-released: 2024-04-28
 license: MIT
 message: "We acknowledge the importance of good software to support research, and we note that research becomes more valuable when it is communicated effectively. To demonstrate the value of Manim, we ask that you cite Manim in your work."
 title: Manim – Mathematical Animation Framework
 url: "https://www.manim.community/"
-version: "v0.18.0"
+version: "v0.18.1"
 ...

LICENSE.community

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021, the Manim Community Developers
+Copyright (c) 2024, the Manim Community Developers
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

conftest.py

@@ -5,12 +5,6 @@
 
 from __future__ import annotations
 
-try:
-    # https://github.com/moderngl/moderngl/issues/517
-    import readline  # required to prevent a segfault on Python 3.10
-except ModuleNotFoundError:  # windows
-    pass
-
 import cairo
 import moderngl
 

docker/Dockerfile

@@ -2,7 +2,6 @@ FROM python:3.11-slim
 
 RUN apt-get update -qq \
     && apt-get install --no-install-recommends -y \
-        ffmpeg \
         build-essential \
         gcc \
         cmake \
@@ -23,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

docs/requirements.txt

@@ -1,5 +1,5 @@
 furo
 myst-parser
-sphinx<5.1
+sphinx>=7.3
 sphinx-copybutton
 sphinxext-opengraph

docs/source/changelog.rst

@@ -2,6 +2,10 @@
 Changelog
 #########
 
+This page contains a list of changes made between releases. Changes
+from versions that are not listed below (in particular patch-level
+releases since v0.18.0) are documented on our
+`GitHub release page <https://github.com/ManimCommunity/manim/releases/>`__.
 
 .. toctree::
 

docs/source/conf.py

@@ -8,6 +8,7 @@
 
 import os
 import sys
+from datetime import datetime
 from pathlib import Path
 
 import manim
@@ -25,7 +26,7 @@
 # -- Project information -----------------------------------------------------
 
 project = "Manim"
-copyright = "2020-2022, The Manim Community Dev Team"
+copyright = f"2020-{datetime.now().year}, The Manim Community Dev Team"
 author = "The Manim Community Dev Team"
 
 

docs/source/contributing/development.rst

@@ -51,8 +51,8 @@ For first-time contributors
 #. Install Manim:
 
    - Follow the steps in our :doc:`installation instructions
-     <../installation>` to install **Manim's dependencies**,
-     primarily ``ffmpeg`` and ``LaTeX``.
+     <../installation>` to install **Manim's system dependencies**.
+     We also recommend installing a LaTeX distribution.
 
    - We recommend using `Poetry <https://python-poetry.org>`__ to manage your
      developer installation of Manim. Poetry is a tool for dependency
@@ -62,7 +62,7 @@ For first-time contributors
      managing virtual environments.
 
      If you choose to use Poetry as well, follow `Poetry's installation
-     guidelines <https://python-poetry.org/docs/master/#installation>`__
+     guidelines <https://python-poetry.org/docs/master/#installing-with-pipx>`__
      to install it on your system, then run ``poetry install`` from
      your cloned repository. Poetry will then install Manim, as well
      as create and enter a virtual environment. You can always re-enter

docs/source/contributing/docs.rst

@@ -81,3 +81,4 @@ Index
    docs/examples
    docs/references
    docs/typings
+   docs/types