manim/docs/source/reference.rst
Benjamin Hackl b46d21e00e
Utility class for animated Manim banner (#729)
* first suggestion for working expansion

* minimal docs

* Update manim/utils/manim_banner.py

Co-authored-by: Leo Torres <dleonardotn@gmail.com>

* added import statement

* newline between manim directive and first code line

* get rid of silly local variables

* make it easier to understand shift

* forgot to replace occurrence of ds_m

* this is what I would really like to work

* black

* change output of gnufsfs template to .xdv

* revert to uglier but working version of ManimBanner.expand

* typo in docstring

* dark and light background examples

* expose ManimBanner

* remove updater method

* forgot to rename example classes

* change banner position in BannerLightBackground

* utils.manim_banner --> mobject.logo

* fix import

* add more documentation

* small fix for scale

* add comment for anim not being a submobject

* move comment to make black happy

Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>
Co-authored-by: Leo Torres <dleonardotn@gmail.com>
Co-authored-by: kolibril13 <jan-hendrik.mueller@gmx.net>
2020-12-01 01:42:16 +01:00

144 lines
2.5 KiB
ReStructuredText

Reference
===============
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.
.. currentmodule:: manim
********
Mobjects
********
.. autosummary::
:toctree: reference
~mobject.changing
~mobject.coordinate_systems
~mobject.frame
~mobject.functions
~mobject.geometry
~mobject.logo
~mobject.matrix
~mobject.mobject
~mobject.mobject_update_utils
~mobject.number_line
~mobject.numbers
~mobject.probability
~mobject.shape_matchers
~mobject.three_d_utils
~mobject.three_dimensions
~mobject.value_tracker
~mobject.vector_field
~mobject.svg.brace
~mobject.svg.code_mobject
~mobject.svg.svg_mobject
~mobject.svg.tex_mobject
~mobject.svg.text_mobject
~mobject.types.image_mobject
~mobject.types.point_cloud_mobject
~mobject.types.vectorized_mobject
******
Scenes
******
.. autosummary::
:toctree: reference
~scene.graph_scene
~scene.moving_camera_scene
~scene.reconfigurable_scene
~scene.sample_space_scene
~scene.scene
~scene.scene_file_writer
~scene.three_d_scene
~scene.vector_space_scene
~scene.zoomed_scene
**********
Animations
**********
.. autosummary::
:toctree: reference
~animation.animation
~animation.composition
~animation.creation
~animation.fading
~animation.growing
~animation.indication
~animation.movement
~animation.numbers
~animation.rotation
~animation.transform
~animation.update
*******
Cameras
*******
.. autosummary::
:toctree: reference
~camera.camera
~camera.mapping_camera
~camera.moving_camera
~camera.multi_camera
~camera.three_d_camera
*************
Configuration
*************
.. autosummary::
:toctree: reference
~_config
~_config.utils
~_config.main_utils
~_config.logger_utils
*********
Utilities
*********
.. autosummary::
:toctree: reference
~utils.bezier
~utils.color
~utils.config_ops
~utils.hashing
~utils.images
~utils.iterables
~utils.paths
~utils.rate_functions
~utils.simple_functions
~utils.sounds
~utils.space_ops
~utils.strings
~utils.tex
~utils.tex_templates
~utils.tex_file_writing
*************
Other modules
*************
.. autosummary::
:toctree: reference
constants
container