From 4c8243f7032ded02664952cc43e3cd4b8e0a9b93 Mon Sep 17 00:00:00 2001 From: HairlessVillager Date: Thu, 4 Apr 2024 23:31:44 +0800 Subject: [PATCH 1/5] Docs: fix out-dated CLI option in Manim's Output Settings --- docs/source/tutorials/output_and_config.rst | 31 ++++++--------------- 1 file changed, 9 insertions(+), 22 deletions(-) diff --git a/docs/source/tutorials/output_and_config.rst b/docs/source/tutorials/output_and_config.rst index 483cd88296..d6620f1a06 100644 --- a/docs/source/tutorials/output_and_config.rst +++ b/docs/source/tutorials/output_and_config.rst @@ -276,25 +276,12 @@ When executing the command manim -pql scene.py SquareToCircle -it was necessary to specify which ``Scene`` class to render. This is because a -single file can contain more than one ``Scene`` class. If your file contains -multiple ``Scene`` classes, and you want to render them all, you can use the -``-a`` flag. - -As discussed previously, the ``-ql`` specifies low render quality. This does -not look very good, but is very useful for rapid prototyping and testing. The -other options that specify render quality are ``-qm``, ``-qh``, and ``-qk`` for -medium, high, and 4k quality, respectively. - -The ``-p`` flag plays the animation once it is rendered. If you want to open -the file browser at the location of the animation instead of playing it, you -can use the ``-f`` flag. You can also omit these two flags. - -Finally, by default manim will output .mp4 files. If you want your animations -in .gif format instead, use the ``-i`` flag. The output files will be in the -same folder as the .mp4 files, and with the same name, but a different file -extension. - -This was a quick review of some of the most frequent command-line flags. For a -thorough review of all flags available, see the -:doc:`thematic guide on Manim's configuration system `. +it specifies the scene to render. This is not necessary now. When a single file contains only one ``Scene`` class, it just render the only one. When a single file contains more than one ``Scene`` class, you can leave a blank, and the manim will let you choose a ``Scene`` class. If your file contains multiple ``Scene`` classes, and you want to render them all, you can use the ``-a`` flag. + +As discussed previously, the ``-ql`` specifies low render quality (854x480 15FPS). This does not look very good, but is very useful for rapid prototyping and testing. The other options that specify render quality are ``-qm``, ``-qh``, ``-qp`` and ``-qk`` for medium (1280x720 30FPS), high (1920x1080 60FPS), 2k (2560x1440 60FPS) and 4k quality (3840x2160 60FPS), respectively. + +The ``-p`` flag plays the animation once it is rendered. If you want to open the file browser at the location of the animation instead of playing it, you can use the ``-f`` flag. You can also omit these two flags. + +Finally, by default manim will output .mp4 files. If you want your animations in .gif format instead, use the ``--format gif`` flag. The output files will be in the same folder as the .mp4 files, and with the same name, but a different file extension. + +This was a quick review of some of the most frequent command-line flags. For a thorough review of all flags available, see the :doc:`thematic guide on Manim's configuration system `. From 6c606ece64b79f5f1ed1e95efe169ed00415cb7a Mon Sep 17 00:00:00 2001 From: HairlessVillager <64526732+HairlessVillager@users.noreply.github.com> Date: Mon, 8 Apr 2024 19:07:19 +0800 Subject: [PATCH 2/5] Docs: more fluent English Co-authored-by: adeshpande <110117391+JasonGrace2282@users.noreply.github.com> --- docs/source/tutorials/output_and_config.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/tutorials/output_and_config.rst b/docs/source/tutorials/output_and_config.rst index d6620f1a06..fa5587524d 100644 --- a/docs/source/tutorials/output_and_config.rst +++ b/docs/source/tutorials/output_and_config.rst @@ -276,7 +276,7 @@ When executing the command manim -pql scene.py SquareToCircle -it specifies the scene to render. This is not necessary now. When a single file contains only one ``Scene`` class, it just render the only one. When a single file contains more than one ``Scene`` class, you can leave a blank, and the manim will let you choose a ``Scene`` class. If your file contains multiple ``Scene`` classes, and you want to render them all, you can use the ``-a`` flag. +it specifies the scene to render. This is not necessary now. When a single file contains only one ``Scene`` class, it will render that class. When a single file contains more than one ``Scene`` class, manim will let you choose a ``Scene`` class. If your file contains multiple ``Scene`` classes, and you want to render them all, you can use the ``-a`` flag. As discussed previously, the ``-ql`` specifies low render quality (854x480 15FPS). This does not look very good, but is very useful for rapid prototyping and testing. The other options that specify render quality are ``-qm``, ``-qh``, ``-qp`` and ``-qk`` for medium (1280x720 30FPS), high (1920x1080 60FPS), 2k (2560x1440 60FPS) and 4k quality (3840x2160 60FPS), respectively. From 1f8c328cc1f1a77d40673677c45297578d8f4b9a Mon Sep 17 00:00:00 2001 From: HairlessVillager Date: Mon, 8 Apr 2024 19:18:13 +0800 Subject: [PATCH 3/5] Docs: break lines --- docs/source/tutorials/output_and_config.rst | 35 +++++++++++++++------ 1 file changed, 26 insertions(+), 9 deletions(-) diff --git a/docs/source/tutorials/output_and_config.rst b/docs/source/tutorials/output_and_config.rst index fa5587524d..de10422617 100644 --- a/docs/source/tutorials/output_and_config.rst +++ b/docs/source/tutorials/output_and_config.rst @@ -276,12 +276,29 @@ When executing the command manim -pql scene.py SquareToCircle -it specifies the scene to render. This is not necessary now. When a single file contains only one ``Scene`` class, it will render that class. When a single file contains more than one ``Scene`` class, manim will let you choose a ``Scene`` class. If your file contains multiple ``Scene`` classes, and you want to render them all, you can use the ``-a`` flag. - -As discussed previously, the ``-ql`` specifies low render quality (854x480 15FPS). This does not look very good, but is very useful for rapid prototyping and testing. The other options that specify render quality are ``-qm``, ``-qh``, ``-qp`` and ``-qk`` for medium (1280x720 30FPS), high (1920x1080 60FPS), 2k (2560x1440 60FPS) and 4k quality (3840x2160 60FPS), respectively. - -The ``-p`` flag plays the animation once it is rendered. If you want to open the file browser at the location of the animation instead of playing it, you can use the ``-f`` flag. You can also omit these two flags. - -Finally, by default manim will output .mp4 files. If you want your animations in .gif format instead, use the ``--format gif`` flag. The output files will be in the same folder as the .mp4 files, and with the same name, but a different file extension. - -This was a quick review of some of the most frequent command-line flags. For a thorough review of all flags available, see the :doc:`thematic guide on Manim's configuration system `. +it specifies the scene to render. This is not necessary now. When a single +file contains only one ``Scene`` class, it just render the only one. When a +single file contains more than one ``Scene`` class, you can leave a blank, +and the manim will let you choose a ``Scene`` class. If your file contains +multiple ``Scene`` classes, and you want to render them all, you can use +the ``-a`` flag. + +As discussed previously, the ``-ql`` specifies low render quality (854x480 +15FPS). This does not look very good, but is very useful for rapid +prototyping and testing. The other options that specify render quality are +``-qm``, ``-qh``, ``-qp`` and ``-qk`` for medium (1280x720 30FPS), high +(1920x1080 60FPS), 2k (2560x1440 60FPS) and 4k quality (3840x2160 60FPS), +respectively. + +The ``-p`` flag plays the animation once it is rendered. If you want to open +the file browser at the location of the animation instead of playing it, you +can use the ``-f`` flag. You can also omit these two flags. + +Finally, by default manim will output .mp4 files. If you want your animations +in .gif format instead, use the ``--format gif`` flag. The output files will +be in the same folder as the .mp4 files, and with the same name, but a +different file extension. + +This was a quick review of some of the most frequent command-line flags. +For a thorough review of all flags available, see the :doc:`thematic guide on +Manim's configuration system `. From ec2bdd0c554a95863356b5d0ef4115cf6063d6d1 Mon Sep 17 00:00:00 2001 From: HairlessVillager Date: Tue, 9 Apr 2024 08:23:11 +0800 Subject: [PATCH 4/5] Docs: more fluent English --- docs/source/tutorials/output_and_config.rst | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/source/tutorials/output_and_config.rst b/docs/source/tutorials/output_and_config.rst index de10422617..e122b8249a 100644 --- a/docs/source/tutorials/output_and_config.rst +++ b/docs/source/tutorials/output_and_config.rst @@ -277,11 +277,10 @@ When executing the command manim -pql scene.py SquareToCircle it specifies the scene to render. This is not necessary now. When a single -file contains only one ``Scene`` class, it just render the only one. When a -single file contains more than one ``Scene`` class, you can leave a blank, -and the manim will let you choose a ``Scene`` class. If your file contains -multiple ``Scene`` classes, and you want to render them all, you can use -the ``-a`` flag. +file contains only one ``Scene`` class, it will just render the ``Scene`` +class. When a single file contains more than one ``Scene`` class, manim will +let you choose a ``Scene`` class. If your file contains multiple ``Scene`` +classes, and you want to render them all, you can use the ``-a`` flag. As discussed previously, the ``-ql`` specifies low render quality (854x480 15FPS). This does not look very good, but is very useful for rapid From 3e02ac068266ac5e8a1d142dd5630e5b1c08c7ef Mon Sep 17 00:00:00 2001 From: HairlessVillager <64526732+HairlessVillager@users.noreply.github.com> Date: Fri, 12 Apr 2024 10:27:40 +0800 Subject: [PATCH 5/5] Docs: remove a space Co-authored-by: adeshpande <110117391+JasonGrace2282@users.noreply.github.com> --- docs/source/tutorials/output_and_config.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/tutorials/output_and_config.rst b/docs/source/tutorials/output_and_config.rst index e122b8249a..af7961d873 100644 --- a/docs/source/tutorials/output_and_config.rst +++ b/docs/source/tutorials/output_and_config.rst @@ -279,7 +279,7 @@ When executing the command it specifies the scene to render. This is not necessary now. When a single file contains only one ``Scene`` class, it will just render the ``Scene`` class. When a single file contains more than one ``Scene`` class, manim will -let you choose a ``Scene`` class. If your file contains multiple ``Scene`` +let you choose a ``Scene`` class. If your file contains multiple ``Scene`` classes, and you want to render them all, you can use the ``-a`` flag. As discussed previously, the ``-ql`` specifies low render quality (854x480