merge master

Author: leotrs

.github/manimdependency.json

@@ -1,6 +1,25 @@
 {
-    "windows": {
-        "ffmpeg": "https://www.gyan.dev/ffmpeg/builds/packages/ffmpeg-4.3.1-2020-09-21-full_build.zip",
-        "pango": "v0.1.0"
-    }
+	"windows": {
+		"ffmpeg": "https://www.gyan.dev/ffmpeg/builds/packages/ffmpeg-4.3.1-2020-09-21-full_build.zip",
+		"pango": "v0.1.0",
+		"tinytex": [
+			"standalone",
+			"preview",
+			"doublestroke",
+			"ms",
+			"setspace",
+			"rsfs",
+			"relsize",
+			"ragged2e",
+			"fundus-calligra",
+			"microtype",
+			"wasysym",
+			"physics",
+			"dvisvgm",
+			"jknapltx",
+			"wasy",
+			"cm-super",
+			"babel-english"
+		]
+	}
 }

.github/workflows/ci.yml

@@ -1,22 +1,22 @@
 name: CI
 on:
   push:
-      branches:
-        - master
+    branches:
+      - master
   pull_request:
-      branches:
-        - master
+    branches:
+      - master
 
 jobs:
   test:
     runs-on: ${{ matrix.os }}
     env:
-       POETRY_VIRTUALENVS_CREATE: false
+      POETRY_VIRTUALENVS_CREATE: false
     strategy:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python: [3.6,3.7, 3.8]
+        python: [3.6, 3.7, 3.8]
 
     steps:
       - name: Checkout the repository
@@ -36,8 +36,8 @@ jobs:
         shell: bash
         id: pip-cache-and-time
         run: |
-           echo "::set-output name=dir::$(pip cache dir)"
-           echo "::set-output name=date::$(/bin/date -u "+%m%Y")"
+          echo "::set-output name=dir::$(pip cache dir)"
+          echo "::set-output name=date::$(/bin/date -u "+%m%Y")"
 
       - name: pip cache
         uses: actions/cache@v2
@@ -73,27 +73,31 @@ jobs:
         if: runner.os == 'Windows'
         uses: actions/cache@v2
         with:
-         path: ${{ github.workspace }}\ManimCache
-         key: ${{ runner.os }}-dependencies-ffmpeg-tinytex-${{ hashFiles('.github/manimdependency.json') }}-${{ steps.pip-cache-and-time.outputs.date }}
+          path: ${{ github.workspace }}\ManimCache
+          key: ${{ runner.os }}-dependencies-ffmpeg-tinytex-${{ hashFiles('.github/manimdependency.json') }}-${{ steps.pip-cache-and-time.outputs.date }}
 
       - name: Download system dependencies (Windows)
         if: runner.os == 'Windows' && steps.cache-windows.outputs.cache-hit != 'true'
         run: |
           $ffmpegUrl = python -c "import json;print(json.load(open('.github/manimdependency.json'))['windows']['ffmpeg'])"
           $pangoVersion = python -c "import json;print(json.load(open('.github/manimdependency.json'))['windows']['pango'])"
+          $tinyTexPackages = $(python -c "import json;print(' '.join(json.load(open('.github/manimdependency.json'))['windows']['tinytex']))") -Split ' '
           $OriPath = $env:PATH
           echo "Install Tinytex"
           Invoke-WebRequest "https://ci.appveyor.com/api/projects/yihui/tinytex/artifacts/TinyTeX.zip?job=image:%20Visual%20Studio%202019" -O "$($env:TMP)\TinyTex.zip"
           Expand-Archive -LiteralPath "$($env:TMP)\TinyTex.zip" -DestinationPath "$($PWD)\ManimCache\LatexWindows"
           $env:Path = "$($PWD)\ManimCache\LatexWindows\TinyTeX\bin\win32;$($env:PATH)"
           tlmgr update --self
-          tlmgr install standalone preview doublestroke ms setspace rsfs relsize ragged2e fundus-calligra microtype wasysym physics dvisvgm jknapltx wasy cm-super babel-english
+          foreach ($c in $tinyTexPackages){
+            $c=$c.Trim()
+            tlmgr install $c
+          }
           $env:PATH=$OriPath
           echo "Completed Latex"
           Invoke-WebRequest "$ffmpegUrl" -O "$($env:TMP)\ffmpeg.zip"
           7z x "$($env:TMP)\ffmpeg.zip" -o"$($PWD)\ManimCache"
           Move-Item "ManimCache\ffmpeg-*" "ManimCache\FFmpeg"
-          Invoke-WebRequest "https://github.com/ManimCommunity/manim-windows/releases/download/$($pangoVersion)/pango-windows-binaires-x64.zip" -O "$($env:TMP)\Pango.zip"
+          Invoke-WebRequest "https://github.com/ManimCommunity/pango-windows-binaries/releases/download/$($pangoVersion)/pango-windows-binaires-x64.zip" -O "$($env:TMP)\Pango.zip"
           mkdir "$($PWD)\ManimCache\Pango"
           7z x "$($env:TMP)\Pango.zip" -o"$($PWD)\ManimCache\Pango"
 

.gitignore

@@ -58,6 +58,7 @@ docs/_build/
 docs/build/
 docs/source/_autosummary/
 docs/source/reference/
+docs/source/_build/
 
 # PyBuilder
 target/

README.md

@@ -10,27 +10,26 @@ Manim is an animation engine for explanatory math videos. It's used to create pr
 
 > NOTE: This repository is maintained by the Manim Community, and is not associated with Grant Sanderson or 3Blue1Brown in any way (though we are definitely indebted to him for providing his work to the world). If you want to study how Grant makes his videos, head over to his repository (3b1b/manim). This is a more frequently updated repository than that one, and is recommended if you want to use Manim for your own projects.
 
-
 ## Table of Contents:
+
 - [Installation](#installation)
 - [Usage](#usage)
 - [Documentation](#documentation)
 - [Help with Manim](#help-with-manim)
 - [Contributing](#contributing)
 - [License](#license)
 
-
 ## Installation
 
 Manim has a few dependencies that need to be installed before it. Please visit
 the
 [documentation](https://manimce.readthedocs.io/en/latest/installation.html)
 and follow the instructions according to your operating system.
 
-
 ## Usage
 
 Here is an example manim script:
+
 ```python
 from manim import *
 
@@ -47,18 +46,18 @@ class SquareToCircle(Scene):
         self.play(FadeOut(square))
 ```
 
-Save this code in a file called `example.py`.  Now open your terminal in the
+Save this code in a file called `example.py`. Now open your terminal in the
 folder where you saved the file and execute
+
 ```sh
 manim example.py SquareToCircle -pl
 ```
 
 You should see your video player pop up and play a simple scene where a square
-is transformed into a circle.  You can find some more simple examples in the
+is transformed into a circle. You can find some more simple examples in the
 [GitHub repository](https://github.com/ManimCommunity/manim/tree/master/example_scenes).
 Visit the [official gallery](https://manimce.readthedocs.io/en/latest/examples.html) for more advanced examples.
 
-
 ## Command line arguments
 
 The general usage of manim is as follows:
@@ -68,33 +67,33 @@ The general usage of manim is as follows:
 The `-p` flag in the command above is for previewing, meaning the video file will automatically open when it is done rendering. The `-l` flag is for a faster rendering at a lower quality.
 
 Some other useful flags include:
-* `-s` to skip to the end and just show the final frame.
-* `-n <number>` to skip ahead to the `n`'th animation of a scene.
-* `-f` show the file in the file browser.
+
+- `-s` to skip to the end and just show the final frame.
+- `-n <number>` to skip ahead to the `n`'th animation of a scene.
+- `-f` show the file in the file browser.
 
 For a thorough list of command line arguments, visit the
 [documentation](https://manimce.readthedocs.io/en/latest/tutorials/configuration.html).
 
-
 ## Documentation
-Documentation is in progress at [ReadTheDocs](https://manimce.readthedocs.io/en/latest/).
 
+Documentation is in progress at [ReadTheDocs](https://manimce.readthedocs.io/en/latest/).
 
 ## Help with Manim
+
 If you need help installing or using Manim, please take a look at [the Reddit
 Community](https://www.reddit.com/r/manim) or the [Discord
-Community](https://discord.gg/mMRrZQW).  For bug reports and feature requests,
+Community](https://discord.gg/mMRrZQW). For bug reports and feature requests,
 please open an issue.
 
-
 ## Contributing
+
 Is always welcome. In particular, there is a dire need for tests and
 documentation. For guidelines please see the
 [documentation](https://manimce.readthedocs.io/en/latest/contributing.html).
 This project uses [Poetry](https://python-poetry.org/docs/) for management. You need to have poetry installed and available in your environment.
 You can find more information about it in its [Documentation](https://manimce.readthedocs.io/en/latest/installation/for_dev.html)
 
-
 ## License
 
 The software is double-licensed under the MIT license, with copyright

docs/requirements.txt

@@ -1,3 +1,4 @@
 Sphinx==3.1.2
 guzzle-sphinx-theme
 recommonmark>=0.5.0
+sphinx-copybutton

docs/source/_static/custom.css

@@ -28,3 +28,8 @@ img {
     padding: 14px 0 14px 20px;
     margin: 20px 0;
 }
+
+div.example-reference {
+    background-color: #dff0d8;
+    border: 1px solid #3c763d;
+}

docs/source/_static/manim-logo-sidebar.svg

@@ -0,0 +1,2 @@
+<img src="{{ pathto('_static/manim-logo-sidebar.svg', 1) }}" alt="ManimCommunity logo" width="100%">
+<a href="{{ homepage() }}" class="text-logo">{{ theme_project_nav_name or shorttitle }}</a>

docs/source/_static/non_standard_rate_funcs.png

@@ -2,11 +2,33 @@
 Changelog
 *********
 
-manimce-v1.0.0-dev
+
+v0.2.0
 ==================
 
 :Date: TBD
 
+Changes since Manim Community release v0.1.0
+
+
+
+Mobjects, Scenes, and Animations
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+#. The ``alignment`` attribute to Tex and MathTex has been removed in favour of ``tex_environment``.
+
+
+
+
+
+
+
+
+v0.1.0
+==================
+
+:Date: October 21, 2020
+
 This is the first release of manimce after forking from 3b1b/manim.  As such,
 developers have focused on cleaning up and refactoring the codebase while still
 maintaining backwards compatibility wherever possible.
@@ -20,7 +42,7 @@ Command line
 ^^^^^^^^^^^^
 
 #. Output of 'manim --help' has been improved
-#. Implement logging with the :code:`rich` library and a :code:`logger` object instead of plain ol` prints
+#. Implement logging with the :code:`rich` library and a :code:`logger` object instead of plain ol' prints
 #. Added a flag :code:`--dry_run`, which doesn’t write any media
 #. Allow for running manim with :code:`python3 -m manim`
 #. Refactored Tex Template management. You can now use custom templates with command line args using :code:`--tex_template`!
@@ -42,6 +64,16 @@ Config system
 #. Implement a :code:`manim.cfg` config file system, that consolidates the global configuration, the command line argument parsing, and some of the constants defined in :code:`constants.py`
 #. Added utilities for manipulating Manim’s :code:`.cfg` files.
 #. Added a subcommand structure for easier use of utilities managing :code:`.cfg` files
+#. Also some variables have been moved from ``constants.py`` to the new config system:
+
+    #. ``FRAME_HEIGHT`` to ``config["frame_width"]``
+    #. ``TOP`` to ``config["frame_height"] / 2 * UP``
+    #. ``BOTTOM`` to ``config["frame_height"] / 2 * DOWN``
+    #. ``LEFT_SIDE`` to ``config["frame_width"] / 2 * LEFT``
+    #. ``RIGHT_SIDE`` to ``config["frame_width"] / 2 * RIGHT``
+    #. ``self.camera.frame_rate`` to ``config["frame_rate"]``
+
+
 
 
 Mobjects, Scenes, and Animations
@@ -50,6 +82,7 @@ Mobjects, Scenes, and Animations
 #. Add customizable left and right bracket for :code:`Matrix` mobject and :code:`set_row_colors` method for matrix mobject
 #. Add :code:`AddTeXLetterByLetter` animation
 #. Enhanced GraphScene
+
     #. You can now add arrow tips to axes
     #. extend axes a bit at the start and/or end
     #. have invisible axes
@@ -64,6 +97,7 @@ Mobjects, Scenes, and Animations
 #. Add a :code:`Variable` class for displaying text that continuously updates to reflect the value of a python variable.
 #. The ``Tex`` and ``MathTex`` objects allow you to specify a custom TexTemplate using the ``template`` keyword argument.
 #. :code:`VGroup` now supports printing the class names of contained mobjects and :code:`VDict` supports printing the internal dict of mobjects
+#. Add all the standard easing functions
 #. :code:`Scene` now renders when :code:`Scene.render()` is called rather than upon instantiation.
 #. :code:`ValueTracker` now supports increment using the `+=` operator (in addition to the already existing `increment_value` method)
 #. Add :class:`PangoText` for rendering texts using Pango.
@@ -106,3 +140,6 @@ Other Changes
 #. Rename package from manimlib to manim
 #. Move all imports to :code:`__init__`, so :code:`from manim import *` replaces :code:`from manimlib.imports import *`
 #. Global dir variable handling has been removed. Instead :code:`initialize_directories`, if needed, overrides the values from the cfg files at runtime.
+
+
+