mirror of
https://github.com/ManimCommunity/manim.git
synced 2026-06-22 10:01:47 +00:00
48747a74d9* move tutorials -> tutorials_guide * change title in tutorials_guides * rename: a_deeper_look -> output_and_config * splitting Tutorials * reorder index (sidebar), move some top level sections elsewhere * rename some tutorials * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * replace recommonmark with rest for rendering md files * fixed broken references * fixed **all** warnings and errors during docbuild * faq: help, more structure for landing page * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fix deprecation tests * prepare some sort of skeleton for installation faq * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * ensure that pip from poetry venv is used in pipeline * added myst-parser as dev dependency * remove fixed sphinx version from requirement.txt, don't re-install dependencies * move and improve versions and troubleshooting content to FAQ * resolve broken references * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * help blacken-docs * new: navigating the docs * make different versions question more prominent * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fixed order of tutorials * added explicit references to building blocks and quickstart tutorial * docs -> doc * change a page-reference to a paragraph-reference * pypi manimlib, split answer regarding chocolatey failing * added a note on #beginner-resources Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
111 lines
2.9 KiB
ReStructuredText
111 lines
2.9 KiB
ReStructuredText
Reference Manual
|
|
================
|
|
|
|
This reference manual details modules, functions, and variables included in
|
|
Manim, describing what they are and what they do. For learning how to use
|
|
Manim, see :doc:`tutorials/index`. For a list of changes since the last release, see
|
|
the :doc:`changelog`.
|
|
|
|
.. warning:: The pages linked to here are currently a work in progress.
|
|
|
|
Inheritance Graphs
|
|
------------------
|
|
|
|
Animations
|
|
**********
|
|
|
|
.. inheritance-diagram::
|
|
manim.animation.animation
|
|
manim.animation.changing
|
|
manim.animation.composition
|
|
manim.animation.creation
|
|
manim.animation.fading
|
|
manim.animation.growing
|
|
manim.animation.indication
|
|
manim.animation.movement
|
|
manim.animation.numbers
|
|
manim.animation.rotation
|
|
manim.animation.specialized
|
|
manim.animation.transform
|
|
manim.animation.transform_matching_parts
|
|
manim.animation.updaters.mobject_update_utils
|
|
manim.animation.updaters.update
|
|
:parts: 1
|
|
:top-classes: manim.animation.animation.Animation
|
|
|
|
Cameras
|
|
*******
|
|
|
|
.. inheritance-diagram::
|
|
manim.camera.camera
|
|
manim.camera.mapping_camera
|
|
manim.camera.moving_camera
|
|
manim.camera.multi_camera
|
|
manim.camera.three_d_camera
|
|
:parts: 1
|
|
:top-classes: manim.camera.camera.Camera, manim.mobject.mobject.Mobject
|
|
|
|
Mobjects
|
|
********
|
|
|
|
.. inheritance-diagram::
|
|
manim.mobject.frame
|
|
manim.mobject.geometry.arc
|
|
manim.mobject.geometry.boolean_ops
|
|
manim.mobject.geometry.line
|
|
manim.mobject.geometry.polygram
|
|
manim.mobject.geometry.shape_matchers
|
|
manim.mobject.geometry.tips
|
|
manim.mobject.graph
|
|
manim.mobject.graphing.coordinate_systems
|
|
manim.mobject.graphing.functions
|
|
manim.mobject.graphing.number_line
|
|
manim.mobject.graphing.probability
|
|
manim.mobject.graphing.scale
|
|
manim.mobject.logo
|
|
manim.mobject.matrix
|
|
manim.mobject.mobject
|
|
manim.mobject.table
|
|
manim.mobject.three_d.polyhedra
|
|
manim.mobject.three_d.three_d_utils
|
|
manim.mobject.three_d.three_dimensions
|
|
manim.mobject.svg.brace
|
|
manim.mobject.svg.svg_mobject
|
|
manim.mobject.text.code_mobject
|
|
manim.mobject.text.numbers
|
|
manim.mobject.text.tex_mobject
|
|
manim.mobject.text.text_mobject
|
|
manim.mobject.types.image_mobject
|
|
manim.mobject.types.point_cloud_mobject
|
|
manim.mobject.types.vectorized_mobject
|
|
manim.mobject.value_tracker
|
|
manim.mobject.vector_field
|
|
:parts: 1
|
|
:top-classes: manim.mobject.mobject.Mobject
|
|
|
|
Scenes
|
|
******
|
|
|
|
.. inheritance-diagram::
|
|
manim.scene.moving_camera_scene
|
|
manim.scene.scene
|
|
manim.scene.scene_file_writer
|
|
manim.scene.three_d_scene
|
|
manim.scene.vector_space_scene
|
|
manim.scene.zoomed_scene
|
|
:parts: 1
|
|
:top-classes: manim.scene.scene.Scene, manim.scene.scene.RerunSceneHandler
|
|
|
|
|
|
Module Index
|
|
------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
reference_index/animations
|
|
reference_index/cameras
|
|
reference_index/configuration
|
|
reference_index/mobjects
|
|
reference_index/scenes
|
|
reference_index/utilities_misc
|