Skip to content

armgit / manim

Public Imported from GitHub
0

A community-maintained Python framework for creating mathematical animations.

Remove $ from tutorial commands (#1445)

Skaft199424d713c7
diff --git a/docs/source/tutorials/a_deeper_look.rst b/docs/source/tutorials/a_deeper_look.rst
index b2015cf57..f954ec5f3 100644
--- a/docs/source/tutorials/a_deeper_look.rst
+++ b/docs/source/tutorials/a_deeper_look.rst
@@ -14,7 +14,7 @@ At this point, you have just executed the following command.
.. code-block:: bash
- $ manim -pql scene.py SquareToCircle
+ manim -pql scene.py SquareToCircle
Let's dissect what just happened step by step. First, this command executes
manim on the file ``scene.py``, which contains our animation code. Further,
@@ -57,7 +57,7 @@ the following command,
.. code-block:: bash
- $ manim -pqh scene.py SquareToCircle
+ manim -pqh scene.py SquareToCircle
The ``-ql`` flag (for low quality) has been replaced by the ``-qh`` flag, for
high quality. Manim will take considerably longer to render this file, and it
@@ -144,7 +144,7 @@ When executing the command
.. code-block:: bash
- $ manim -pql scene.py SquareToCircle
+ 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
diff --git a/docs/source/tutorials/configuration.rst b/docs/source/tutorials/configuration.rst
index 8c3b01cf3..3d59c3add 100644
--- a/docs/source/tutorials/configuration.rst
+++ b/docs/source/tutorials/configuration.rst
@@ -81,7 +81,7 @@ Usually, manim is run from the command-line by executing
.. code-block:: bash
- $ manim <file.py> SceneName
+ manim <file.py> SceneName
This asks manim to search for a Scene class called :code:`SceneName` inside the
file <file.py> and render it. One can also specify the render quality by using
@@ -90,7 +90,7 @@ high, and 4k quality, respectively.
.. code-block:: bash
- $ manim -ql <file.py> SceneName
+ manim -ql <file.py> SceneName
These flags set the values of the config options ``config.pixel_width``,
``config.pixel_height``, ``config.frame_rate``, and ``config.quality``.
@@ -110,7 +110,7 @@ instead of the whole video, you can execute
.. code-block:: bash
- $ manim -sqh <file.py> SceneName
+ manim -sqh <file.py> SceneName
The following example specifies the output file name (with the :code:`-o`
flag), renders only the first ten animations (:code:`-n` flag) with a white
@@ -120,7 +120,7 @@ open the file after it is rendered.
.. code-block:: bash
- $ manim -o myscene -i -n 0,10 -c WHITE <file.py> SceneName
+ manim -o myscene -i -n 0,10 -c WHITE <file.py> SceneName
.. tip:: There are many more command-line flags that manim accepts. All the
possible flags are shown by executing ``manim -h``. A complete list
@@ -162,14 +162,14 @@ Now, executing the following command
.. code-block:: bash
- $ manim -o myscene -i -c WHITE <file.py> SceneName
+ manim -o myscene -i -c WHITE <file.py> SceneName
is equivalent to executing the following command, provided that ``manim.cfg``
is in the same directory as <file.py>,
.. code-block:: bash
- $ manim <file.py> SceneName
+ manim <file.py> SceneName
.. tip:: The names of the configuration options admissible in config files are
exactly the same as the **long names** of the corresponding command
@@ -187,7 +187,7 @@ file being rendered, and **not** in the directory of execution. For example,
.. code-block:: bash
- $ manim -o myscene -i -c WHITE <path/to/file.py> SceneName
+ manim -o myscene -i -c WHITE <path/to/file.py> SceneName
will use the config file found in ``path/to/file.py``, if any. It will **not**
use the config file found in the current working directory, even if it exists.
diff --git a/docs/source/tutorials/quickstart.rst b/docs/source/tutorials/quickstart.rst
index 5233a66e6..8f0033072 100644
--- a/docs/source/tutorials/quickstart.rst
+++ b/docs/source/tutorials/quickstart.rst
@@ -60,7 +60,7 @@ the following command:
.. code-block:: bash
- $ manim -pql scene.py SquareToCircle
+ manim -pql scene.py SquareToCircle
After showing some output, manim should render the scene into a .mp4 file,
and open that file with the default movie player application. You should see a
@@ -159,7 +159,7 @@ And render it using the following command:
.. code-block:: bash
- $ manim -pql scene.py SquareToCircle
+ manim -pql scene.py SquareToCircle
The output should look as follows.