A community-maintained Python framework for creating mathematical animations.
Update troubleshooting docs (#1508)
Darylgolden2aaec7ab31ec
diff --git a/docs/source/installation.rst b/docs/source/installation.rstindex f768842fe..82ade4306 100644--- a/docs/source/installation.rst+++ b/docs/source/installation.rst@@ -56,3 +56,8 @@ found at `Docker Hub <https://hub.docker.com/r/manimcommunity/manim>`_.Installation For Developers***************************If you want to contribute to manim, follow the :doc:`contributing` instructions.++Verifying installation+**********************+Please proceed to our :doc:`quickstart guide <tutorials/quickstart>` to run a simple file to test your installation.+If it did not work, please refer to our :doc:`troubleshootinig guide <installation/troubleshooting>` for help.diff --git a/docs/source/installation/troubleshooting.rst b/docs/source/installation/troubleshooting.rstindex 8a27f2786..98b1b4ae2 100644--- a/docs/source/installation/troubleshooting.rst+++ b/docs/source/installation/troubleshooting.rst@@ -1,7 +1,75 @@Troubleshooting===============-List of known installation problems.+Version incompatibility+***********************++Confusion and conflict between versions is by far the most common reason+for installation failures. Some signs and errors resulting from this are+as follows:++- ``There are no scenes in that module``+- ``ModuleNotFoundError: No module named 'manim'``+- ``ModuleNotFoundError: No module named 'manimlib'``+- You followed any tutorial created before October 2020 (because the community edition did not exist before then)+- You cloned a repository on GitHub (installation of the community version for normal use does not require the cloning of any repository)+- Different import statements (explained below)+- You used documentation for multiple versions (such as the readme for 3b1b/manim and this documentation)++.. NOTE::+ As this is the documentation for the community version, we can+ only help with the installation of this library. If you would like to+ install other versions of manim, please refer to their documentation.++Identifying files written for a different version of manim+----------------------------------------------------------++There are some distinctive features of different versions of manim that+can help in identifying what version of manim files are written for:+++--------------+-------------------------+----------------------------+-----------------------------------------++| Feature | ManimCE (this version) | ManimGL | ManimCairo |++==============+=========================+============================+=========================================++| Import | ``from manim import *`` | ``from manimlib import *`` | ``from manimlib.imports import *`` |+| statement | | | |++--------------+-------------------------+----------------------------+-----------------------------------------+++If you are a beginner, you should only attempt to run files written for+your version. Files written for a different version of manim wil+generally not work without some modification.++Identifying the version you are running+---------------------------------------++The community edition of manim should always state `Manim Community <version_number>` as its first line+of any command you run.++Identifying and removing conflicting versions of manim+------------------------------------------------------++Within the system or environment you are using to run manim, run the+following command in the terminal:++.. code-block:: bash++ pip list++The correct package for the community edition is simply ``manim``. If+you do not see this package listed, please refer back to our+installation guide to install it. If you see ``manimlib`` or ``manimce``+(actually an old version of the community edition), you should remove+them with:++.. code-block:: bash++ pip uninstall <package>+++If you have cloned a repository from GitHub, you should either remove it+or run manim outside that folder.++Other errors+************``pip install manim`` fails when installing manimpango?-------------------------------------------------------@@ -27,7 +95,7 @@ using ``pip install --upgrade manim``.-Some letters are missing from TextMobject/TexMobject output?+Some letters are missing from Text/Tex output?------------------------------------------------------------If you have recently installed TeX you may need to build the fonts it