manim/docs/source/reference.rst
Laith Bahodi e040bcacd3
Improved structure of the :mod:.mobject module (#2476)
* group graphing and update its references

* group text and update its references

* group opengl and update its references

* group three_d and update its references

* group geometry and update (most) references

* move some chaning.py + updater files  into animation

* refactor arc.py

* refactor line.py

* refactor polygram.py

* refactor tips.py

* black + isort

* import new files in __init__.py

* refactor places where geometry was used

* black + isort again

* remove unused imports

* update reference.rst

* add descriptions to files

* fix circular imports

* forgot ArrowTip

* fix tests

* fix doctests

* satisfy mypy?

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix ALL merge conflicts

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* one VMobject import slipped through

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* re-add imports to `manim/opengl/__init__.py`

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix reference manual

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* ignore unknown directive type

* fix arrow tip imports in docstrings

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2022-02-24 09:29:28 +01:00

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`. 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
manim.animation.updaters.value_tracker
: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_system
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.tex_mobject
manim.mobject.text.text_mobject
manim.mobject.text.numbers
manim.mobject.types.image_mobject
manim.mobject.types.point_cloud_mobject
manim.mobject.types.vectorized_mobject
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