Skip to content

Adding a tour through Manim #4143

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 54 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
54 commits
Select commit Hold shift + click to select a range
0e9f2f8
Adding a tour through manim
MrDiver Dec 5, 2023
1a7cf2a
Added introduction animations
JasonGrace2282 Dec 7, 2023
cc06740
Added Transform vs ReplacementTransform
JasonGrace2282 Dec 7, 2023
598828a
Added Transform stuff and rate functions
JasonGrace2282 Dec 8, 2023
6a74bc2
Revert commits
JasonGrace2282 Dec 8, 2023
59231a8
Added Transform and Rate functions
JasonGrace2282 Dec 8, 2023
72753ab
Update ``adventure.rst``
JasonGrace2282 Dec 9, 2023
0bf0b1a
Merge branch 'main' into guide
MrDiver Dec 9, 2023
ba7e90b
Added knowledge check
JasonGrace2282 Dec 9, 2023
94121e4
Added knowledge check
JasonGrace2282 Dec 9, 2023
d261fd3
Added VGroup demo
JasonGrace2282 Dec 20, 2023
636265b
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 20, 2023
7866e00
Merge branch 'main' into guide
JasonGrace2282 Dec 21, 2023
8ebc172
Made into section
JasonGrace2282 Dec 21, 2023
223a4e1
Merge branch 'main' into guide
JasonGrace2282 Dec 21, 2023
a668648
grammer fixes
JasonGrace2282 Dec 21, 2023
d8235da
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 21, 2023
3c3f4d8
Modified Authors
JasonGrace2282 Dec 22, 2023
12198f9
update docstring of ManimColor
JasonGrace2282 Dec 28, 2023
dd9798a
Merge branch 'guide' of https://github.com/MrDiver/manim into guide
JasonGrace2282 Dec 28, 2023
1c8b1c9
Added rate functions animation
JasonGrace2282 Dec 28, 2023
9596c71
Merge branch 'main' into guide
JasonGrace2282 Dec 28, 2023
fbe9335
Merge branch 'main' into guide
JasonGrace2282 Jan 15, 2024
4543191
Add Updater section
JasonGrace2282 Jan 15, 2024
4ea6743
Merge branch 'guide' of https://github.com/MrDiver/manim into guide
JasonGrace2282 Jan 15, 2024
59175d8
Added ref classes and fixed typos
JasonGrace2282 Jan 16, 2024
0a9d095
Merge branch 'main' into guide
JasonGrace2282 Jan 16, 2024
c31e1b1
Fix reST
JasonGrace2282 Jan 16, 2024
96c2242
Merge branch 'main' into guide
JasonGrace2282 Jan 16, 2024
6d4b595
Change typo from nonlocal var to local parameter
JasonGrace2282 Feb 2, 2024
ab042d3
Reword adventure/index.rst
JasonGrace2282 Mar 11, 2024
95f7d0c
Bump github/codeql-action from 2 to 3 (#3567)
dependabot[bot] Jan 24, 2024
978b3e7
Merge branch 'main' into guide
JasonGrace2282 Mar 31, 2024
7164252
Add progress on project
JasonGrace2282 Mar 31, 2024
3c1a01a
Reword introduction of :class:`Transform`
JasonGrace2282 May 26, 2024
cd88ffd
better explanation of Transform vs ReplacementTransform
JasonGrace2282 Jul 9, 2024
527b68c
doing -> executing
JasonGrace2282 Jul 9, 2024
79e5b80
Merge branch 'main' of https://github.com/ManimCommunity/manim into g…
JasonGrace2282 Jul 9, 2024
5d29e2a
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jul 9, 2024
fbd04a7
some more hyperlinks
JasonGrace2282 Aug 28, 2024
6de9a0a
Merge branch 'main' of https://github.com/ManimCommunity/manim into g…
JasonGrace2282 Aug 28, 2024
a866bb6
Change to manim init
JasonGrace2282 Aug 30, 2024
ccbb3d3
Fixed dropdown not working in project adventure
fnieri Oct 5, 2024
e9fe3f8
Added subsections for algebraic and geometric vector addition
fnieri Oct 10, 2024
03ae492
Added poetry dependency
fnieri Oct 15, 2024
ae0509c
Changed basic project to reflect feedback
fnieri Oct 15, 2024
b7fc13a
Added dropdown admonition in "Adding Admonitions" section for contrib…
fnieri Oct 15, 2024
83d5f9d
Fixed override_animation reference from :meth: to :func:
fnieri Oct 16, 2024
e614b08
Move sphinx-togglebutton into dev-dependencies
JasonGrace2282 Oct 19, 2024
7267c72
Fill out the basic project guide
JasonGrace2282 Oct 19, 2024
b81b7ec
Merge branch 'main' of https://github.com/ManimCommunity/manim into g…
JasonGrace2282 Jan 20, 2025
be9443f
add missing comma
JasonGrace2282 Jan 20, 2025
aae02f6
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 20, 2025
f2f35cf
add sphinx-togglebutton as dep
JasonGrace2282 Jan 20, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file removed docs/html
Empty file.
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ sphinx>=7.3
sphinx-copybutton
sphinxext-opengraph
sphinx-design
sphinx-togglebutton
sphinx-reredirects
1 change: 1 addition & 0 deletions docs/rtd-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
jupyterlab
sphinxcontrib-programoutput
sphinx-design
Empty file removed docs/skip-manim
Empty file.
Binary file added docs/source/_static/AdventureManim.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
696 changes: 696 additions & 0 deletions docs/source/adventure/basics.rst

Large diffs are not rendered by default.

38 changes: 38 additions & 0 deletions docs/source/adventure/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
##############################
Exploring Manim's Capabilities
##############################

=============
What is this?
=============

One of the hardest parts of learning how to use Manim is to deviate from the quickstart and basic examples given in the documentation,
and coding your own animation. By the end of this, you should have had some experience learning how to go about with this!

--------------------
Part One: The Basics
--------------------

Here we talk about the basics: what are Mobjects, Animations, Groups, Updaters, and many other basic aspects of Manim. It gives many examples
about each concept, and encourages you to test your understanding by recreating certain sequences of animations.
Feel free to return to this section anytime you need a refresher on something during part two.

---------------------
Part Two: The Project
---------------------

.. note:: As of right now, this section is still under construction.


Here is the fun part: We go through and make our own creation from start to finish, explaining how to effectively search the documentation,
and come up with the logic to make your ideas come to life. By the end of this section, you should be fully prepared to tackle your own project.

=================
Table of Contents
=================

.. toctree::
:maxdepth: 2

basics
project
Loading
Loading