A community-maintained Python framework for creating mathematical animations.
Fixing broken links and other minor doc things (#1541)
Skaft40bfc27dd26f
diff --git a/docs/source/contributing.rst b/docs/source/contributing.rstindex f285b2fd9..f892be95d 100644--- a/docs/source/contributing.rst+++ b/docs/source/contributing.rst@@ -19,7 +19,7 @@ some are detailed below:* Testing (graphical, unit & video)* Website design and development-.. NOTE::+.. note::Please ensure that you are reading the latest version of this guide by ensuring that "latest" is selected in the version switcher.diff --git a/docs/source/contributing/development.rst b/docs/source/contributing/development.rstindex a932d5323..15191c168 100644--- a/docs/source/contributing/development.rst+++ b/docs/source/contributing/development.rst@@ -140,7 +140,7 @@ pull request. A pull request signifies to the ManimCommunity organization,"Here are some changes I wrote; I think it's worthwhile for you to maintainthem."-.. NOTE::+.. note::You do not need to have everything (code/documentation/tests) completeto open a pull request (PR). If the PR is still under development, pleasediff --git a/docs/source/contributing/testing.rst b/docs/source/contributing/testing.rstindex 2820041bf..cc24c99c6 100644--- a/docs/source/contributing/testing.rst+++ b/docs/source/contributing/testing.rst@@ -141,7 +141,7 @@ The Main DirectoriesUseful internal functions used by pytest.- .. Note:: fixtures are not contained here, they are in ``conftest.py``.+ .. note:: fixtures are not contained here, they are in ``conftest.py``.- ``helpers/``:@@ -181,7 +181,7 @@ Scene names follow the syntax: ``<thing_to_test>Test``. In the example above,we are testing whether Circle properly shows up with the generic``Animation`` and not any specific animation.-.. Note::+.. note::If the file already exists, edit it and add the test within the file. The``Scene`` will be tested thanks to the ``GraphicalUnitTester`` that lives@@ -259,9 +259,9 @@ To test videos generated, we use the decoratorout, err, exit_code = capture(command)assert exit_code == 0, err-.. Note:: ``assert exit*\ code == 0, err`` is used in case of the command fails+.. note:: ``assert exit*\ code == 0, err`` is used in case of the command failsto run. The decorator takes two arguments: json name and the path- to where the video should be generated, starting from the ``medias/`` dir.+ to where the video should be generated, starting from the ``media/`` dir.Note the fixtures here:diff --git a/docs/source/installation.rst b/docs/source/installation.rstindex 82ade4306..cdc6725e5 100644--- a/docs/source/installation.rst+++ b/docs/source/installation.rst@@ -6,7 +6,7 @@ The following pages have instructions that are specific to your system. Onceyou are done installing the dependencies, come back to this page to installmanim itself.-.. NOTE::+.. note::Before installing manim, you should understand that there are a few main versions of manimtoday that are generally incompatible with each other.@@ -60,4 +60,4 @@ 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.+If it did not work, please refer to our :doc:`troubleshooting guide <installation/troubleshooting>` for help.diff --git a/docs/source/installation/troubleshooting.rst b/docs/source/installation/troubleshooting.rstindex 98b1b4ae2..9469f35af 100644--- a/docs/source/installation/troubleshooting.rst+++ b/docs/source/installation/troubleshooting.rst@@ -16,7 +16,7 @@ as follows:- Different import statements (explained below)- You used documentation for multiple versions (such as the readme for 3b1b/manim and this documentation)-.. NOTE::+.. note::As this is the documentation for the community version, we canonly help with the installation of this library. If you would like toinstall other versions of manim, please refer to their documentation.diff --git a/docs/source/installation/versions.rst b/docs/source/installation/versions.rstindex 77f8e54ef..809b634eb 100644--- a/docs/source/installation/versions.rst+++ b/docs/source/installation/versions.rst@@ -26,7 +26,7 @@ The three versions of ManimThere are currently three main versions of manim. They are as follows:-- **ManimCE**: The community edition of manim. This is the version documented by this website, and is named `manim <https://pypi.org/project/manim/https://pypi.org/project/manim/>`_ on pip.+- **ManimCE**: The community edition of manim. This is the version documented by this website, and is named `manim <https://pypi.org/project/manim/>`_ on pip.- `ManimGL <https://github.com/3b1b/manim>`_: The current version of manim that is used by 3blue1brown. It supports OpenGL rendering and interactivity, and is named ``manimgl`` on pip. You can find documentation for it `here <https://3b1b.github.io/manim/index.html>`_.- `ManimCairo <https://github.com/3b1b/manim/tree/cairo-backend>`_: The old version of manim originally used by 3blue1brown. It is not available on pip.diff --git a/docs/source/installation/win.rst b/docs/source/installation/win.rstindex 1ece18ed0..b03d37812 100644--- a/docs/source/installation/win.rst+++ b/docs/source/installation/win.rst@@ -2,7 +2,7 @@ Windows=======There are two simple ways to download manim's depedencies, using the popular package-managers `Scoop <https://shoop.sh>`_ and `Chocolatey <https://chocolatey.org/install>`_+managers `Scoop <https://scoop.sh>`_ and `Chocolatey <https://chocolatey.org/install>`_.. _scoop:diff --git a/docs/source/reference.rst b/docs/source/reference.rstindex 56daaf710..68d1f52ae 100644--- a/docs/source/reference.rst+++ b/docs/source/reference.rst@@ -48,7 +48,7 @@ Mobjects~mobject.types.vectorized_mobject**Mobject** Inheritance Graph-~~~~~~~~~~~~~~~~~~~~~~~~~~+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~.. inheritance-diagram::manim.mobject.changing@@ -102,7 +102,7 @@ Scenes~scene.zoomed_scene**Scene** Inheritance Graph-~~~~~~~~~~~~~~~~~~~~~~~~+~~~~~~~~~~~~~~~~~~~~~~~~~~~.. inheritance-diagram::manim.scene.graph_scene@@ -139,7 +139,7 @@ Animations~animation.update**Animation** Inheritance Graph-~~~~~~~~~~~~~~~~~~~~~~~~~~~~+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~.. inheritance-diagram::manim.animation.animation@@ -172,7 +172,7 @@ Cameras~camera.three_d_camera**Camera** Inheritance Graph-~~~~~~~~~~~~~~~~~~~~~~~~~+~~~~~~~~~~~~~~~~~~~~~~~~~~~~.. inheritance-diagram::manim.camera.cameradiff --git a/manim/mobject/svg/opengl_text_mobject.py b/manim/mobject/svg/opengl_text_mobject.pyindex 1b795252f..19ea8e2c6 100644--- a/manim/mobject/svg/opengl_text_mobject.py+++ b/manim/mobject/svg/opengl_text_mobject.py@@ -725,7 +725,7 @@ class OpenGLMarkupText(OpenGLSVGMobject):You can find more information about Pango markup formatting at thecorresponding documentation page:- `Pango Markup <https://developer.gnome.org/pango/stable/pango-Markup.html>`_.+ `Pango Markup <https://developer.gnome.org/pygtk/stable/pango-markup-language.html>`_.Please be aware that not all features are supported by this class and thatthe ``<gradient>`` tag mentioned above is not supported by Pango.diff --git a/manim/mobject/svg/text_mobject.py b/manim/mobject/svg/text_mobject.pyindex 731d8fca6..9fa2f9edd 100644--- a/manim/mobject/svg/text_mobject.py+++ b/manim/mobject/svg/text_mobject.py@@ -722,7 +722,7 @@ class MarkupText(SVGMobject):You can find more information about Pango markup formatting at thecorresponding documentation page:- `Pango Markup <https://developer.gnome.org/pango/stable/pango-Markup.html>`_.+ `Pango Markup <https://developer.gnome.org/pygtk/stable/pango-markup-language.html>`_.Please be aware that not all features are supported by this class and thatthe ``<gradient>`` tag mentioned above is not supported by Pango.