A community-maintained Python framework for creating mathematical animations.
# Restructured the docs-chapters
kolibril13ba418692f97c
diff --git a/docs/source/_static/quickstart/first_scene.gif b/docs/source/_static/quickstart/first_scene.gifdeleted file mode 100644index c23d42b29..000000000Binary files a/docs/source/_static/quickstart/first_scene.gif and /dev/null differdiff --git a/docs/source/_static/quickstart/first_scene_4k.gif b/docs/source/_static/quickstart/first_scene_4k.gifdeleted file mode 100644index 4bde21aef..000000000Binary files a/docs/source/_static/quickstart/first_scene_4k.gif and /dev/null differdiff --git a/docs/source/_static/quickstart/second_scene.gif b/docs/source/_static/quickstart/second_scene.gifdeleted file mode 100644index abefa7e3e..000000000Binary files a/docs/source/_static/quickstart/second_scene.gif and /dev/null differdiff --git a/docs/source/changelog.rst b/docs/source/changelog.rstdeleted file mode 100644index e35dcd8ef..000000000--- a/docs/source/changelog.rst+++ /dev/null@@ -1,4 +0,0 @@-Changelog-=========--This is a stub file.diff --git a/docs/source/contributing.md b/docs/source/contributing.mdnew file mode 100644index 000000000..d93f74f93--- /dev/null+++ b/docs/source/contributing.md@@ -0,0 +1,3 @@+# Contribution++https://github.com/ManimCommunity/manim\ No newline at end of filediff --git a/docs/source/examples.md b/docs/source/examples.mdnew file mode 100644index 000000000..9db287125--- /dev/null+++ b/docs/source/examples.md@@ -0,0 +1,3 @@+# Examples++Lots of manim examples\ No newline at end of filediff --git a/docs/source/examples/examples_index.rst b/docs/source/examples/examples_index.rstnew file mode 100644index 000000000..7e40fcd9b--- /dev/null+++ b/docs/source/examples/examples_index.rst@@ -0,0 +1,7 @@+Examples+============++.. toctree::+ :caption: Table of Contents++ hello_example\ No newline at end of filediff --git a/docs/source/examples/hello_example.md b/docs/source/examples/hello_example.mdnew file mode 100644index 000000000..d6f214af7--- /dev/null+++ b/docs/source/examples/hello_example.md@@ -0,0 +1,12 @@+# Example 1++```python+from manim import *++class TestExample(Scene):+ def construct(self):+ dot = Dot()+ self.add(dot)+ self.wait(1)+````+diff --git a/docs/source/index.rst b/docs/source/index.rstindex bbc313a1c..59ace2122 100644--- a/docs/source/index.rst+++ b/docs/source/index.rst@@ -17,14 +17,18 @@ information here will make it easier for newcomers to get started using.. toctree::- :maxdepth: 1+ :maxdepth: 2:caption: Documentation- quickstart- tutorial- configuration+ installation/installation_indexreference- changelog+ examples/examples_index+ tutorials/tutorials_index+ contributing++Navigation+==================* :ref:`genindex`* :ref:`modindex`+* :ref:`search`diff --git a/docs/source/installation/installation_arch.rst b/docs/source/installation/installation_arch.rstnew file mode 100644index 000000000..aae24327e--- /dev/null+++ b/docs/source/installation/installation_arch.rst@@ -0,0 +1,2 @@+Arch/Manjaro+=====\ No newline at end of filediff --git a/docs/source/installation/installation_index.rst b/docs/source/installation/installation_index.rstnew file mode 100644index 000000000..f0497a9ed--- /dev/null+++ b/docs/source/installation/installation_index.rst@@ -0,0 +1,10 @@+Installation+============++.. toctree::+ :caption: Table of Contents++ installation_win+ installation_ubuntu+ installation_arch+ installation_mac\ No newline at end of filediff --git a/docs/source/installation/installation_mac.rst b/docs/source/installation/installation_mac.rstnew file mode 100644index 000000000..91d43f3ce--- /dev/null+++ b/docs/source/installation/installation_mac.rst@@ -0,0 +1,2 @@+Mac+=====\ No newline at end of filediff --git a/docs/source/installation/installation_ubuntu.rst b/docs/source/installation/installation_ubuntu.rstnew file mode 100644index 000000000..1be635da5--- /dev/null+++ b/docs/source/installation/installation_ubuntu.rst@@ -0,0 +1,2 @@+Ubuntu/Debian+=====\ No newline at end of filediff --git a/docs/source/installation/installation_win.rst b/docs/source/installation/installation_win.rstnew file mode 100644index 000000000..1d374abe6--- /dev/null+++ b/docs/source/installation/installation_win.rst@@ -0,0 +1,2 @@+Windows+=====\ No newline at end of filediff --git a/docs/source/reference.rst b/docs/source/reference.rstindex 0c9690c1d..69fdb8671 100644--- a/docs/source/reference.rst+++ b/docs/source/reference.rst@@ -1,4 +1,4 @@-Manim Reference+Reference===============This reference manual details functions, modules, and objects included indiff --git a/docs/source/tutorial.md b/docs/source/tutorials/a_deeper_look.mdsimilarity index 95%rename from docs/source/tutorial.mdrename to docs/source/tutorials/a_deeper_look.mdindex fdfedfed9..d14c32502 100644--- a/docs/source/tutorial.md+++ b/docs/source/tutorials/a_deeper_look.md@@ -1,4 +1,4 @@-# Tutorial+# A deeper look[NOTE:] this is some text I wrote that was originally meant to be part of thequickstart. However, after some thought I've decided that it's probably a bit@@ -59,8 +59,8 @@ The `-l` flag (for low quality) has been replaced by the `-k` flag, for 4Kquality. Manim will take considerably longer to render this file, and it willplay it once it's done since we are using the `-p` flag. The output shouldlook like this:+[NOTE:] Output currently removed, because on a normal non 4k screen the scene is to big to be displayed.-And the folder structure should look as follows.diff --git a/docs/source/quickstart.md b/docs/source/tutorials/quickstart.mdsimilarity index 100%rename from docs/source/quickstart.mdrename to docs/source/tutorials/quickstart.mddiff --git a/docs/source/tutorials/tutorials_index.rst b/docs/source/tutorials/tutorials_index.rstnew file mode 100644index 000000000..d69c4b8d7--- /dev/null+++ b/docs/source/tutorials/tutorials_index.rst@@ -0,0 +1,9 @@+Tutorials+============++.. toctree::+ :caption: Table of Contents++ quickstart+ a_deeper_look+