manim/docs/source/reference.rst
Benjamin Hackl e16f9a6cc4
Basic implementation of undirected graphs (#861)
* toying around with a graph using networkx layouting

* basic implementation and documentation of a class for undirected graphs

* import graph module into global namespace

* add graph module to documentation

* poetry: add networkx as a dependency

* remove some debug prints

* sort all extracted mobjects w.r.t. z_index

* add test for z_index (from #327)

* more complex z_index test

* black

* improve imports

* use z_index to have edges below vertices

* add type hints

* rename some tests to make space for graph tests

* fix problem with manual positioning

* add test

* black

* new animate syntax

* document label_fill_color
2020-12-31 21:10:41 +01:00

145 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.graph
~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