Skip to content

armgit / manim

Public Imported from GitHub
0

A community-maintained Python framework for creating mathematical animations.

add manim_directive module to reference manual

Benjamin Hackl54f1063357cb
diff --git a/docs/source/manim_directive.py b/docs/source/manim_directive.py
index aa731e13d..cf92b4c0d 100644
--- a/docs/source/manim_directive.py
+++ b/docs/source/manim_directive.py
@@ -72,7 +72,8 @@ classnamedict = {}
class ManimDirective(Directive):
- r"""The ``.. manim::`` directive.
+ r"""The manim directive, rendering videos while building
+ the documentation.
See the module docstring for documentation.
"""
diff --git a/docs/source/reference.rst b/docs/source/reference.rst
index 804869f38..465ebead0 100644
--- a/docs/source/reference.rst
+++ b/docs/source/reference.rst
@@ -8,7 +8,6 @@ the :doc:`changelog`.
.. warning:: The pages linked to here are currently a work in progress.
-.. currentmodule:: manim
********************
Mathematical Objects
@@ -17,32 +16,32 @@ Mathematical Objects
.. autosummary::
:toctree: reference
- ~mobject.changing
- ~mobject.coordinate_systems
- ~mobject.frame
- ~mobject.functions
- ~mobject.geometry
- ~mobject.matrix
- ~mobject.mobject
- ~mobject.mobject_update_utils
- ~mobject.number_line
- ~mobject.numbers
- ~mobject.probability
- ~mobject.shape_matchers
- ~mobject.three_d_shading_utils
- ~mobject.three_d_utils
- ~mobject.three_dimensions
- ~mobject.value_tracker
- ~mobject.vector_field
- ~mobject.svg.brace
- ~mobject.svg.code_mobject
- ~mobject.svg.drawings
- ~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
+ ~manim.mobject.changing
+ ~manim.mobject.coordinate_systems
+ ~manim.mobject.frame
+ ~manim.mobject.functions
+ ~manim.mobject.geometry
+ ~manim.mobject.matrix
+ ~manim.mobject.mobject
+ ~manim.mobject.mobject_update_utils
+ ~manim.mobject.number_line
+ ~manim.mobject.numbers
+ ~manim.mobject.probability
+ ~manim.mobject.shape_matchers
+ ~manim.mobject.three_d_shading_utils
+ ~manim.mobject.three_d_utils
+ ~manim.mobject.three_dimensions
+ ~manim.mobject.value_tracker
+ ~manim.mobject.vector_field
+ ~manim.mobject.svg.brace
+ ~manim.mobject.svg.code_mobject
+ ~manim.mobject.svg.drawings
+ ~manim.mobject.svg.svg_mobject
+ ~manim.mobject.svg.tex_mobject
+ ~manim.mobject.svg.text_mobject
+ ~manim.mobject.types.image_mobject
+ ~manim.mobject.types.point_cloud_mobject
+ ~manim.mobject.types.vectorized_mobject
******
@@ -52,15 +51,15 @@ 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
+ ~manim.scene.graph_scene
+ ~manim.scene.moving_camera_scene
+ ~manim.scene.reconfigurable_scene
+ ~manim.scene.sample_space_scene
+ ~manim.scene.scene
+ ~manim.scene.scene_file_writer
+ ~manim.scene.three_d_scene
+ ~manim.scene.vector_space_scene
+ ~manim.scene.zoomed_scene
**********
@@ -70,18 +69,18 @@ Animations
.. autosummary::
:toctree: reference
- ~animation.animation
- ~animation.composition
- ~animation.creation
- ~animation.fading
- ~animation.growing
- ~animation.indication
- ~animation.movement
- ~animation.numbers
- ~animation.rotation
- ~animation.specialized
- ~animation.transform
- ~animation.update
+ ~manim.animation.animation
+ ~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.update
*******
@@ -91,11 +90,11 @@ Cameras
.. autosummary::
:toctree: reference
- ~camera.camera
- ~camera.mapping_camera
- ~camera.moving_camera
- ~camera.multi_camera
- ~camera.three_d_camera
+ ~manim.camera.camera
+ ~manim.camera.mapping_camera
+ ~manim.camera.moving_camera
+ ~manim.camera.multi_camera
+ ~manim.camera.three_d_camera
*********
@@ -105,20 +104,20 @@ 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_file_writing
+ ~manim.utils.bezier
+ ~manim.utils.color
+ ~manim.utils.config_ops
+ ~manim.utils.hashing
+ ~manim.utils.images
+ ~manim.utils.iterables
+ ~manim.utils.paths
+ ~manim.utils.rate_functions
+ ~manim.utils.simple_functions
+ ~manim.utils.sounds
+ ~manim.utils.space_ops
+ ~manim.utils.strings
+ ~manim.utils.tex
+ ~manim.utils.tex_file_writing
*************
@@ -128,9 +127,10 @@ Other modules
.. autosummary::
:toctree: reference
- _config
- constants
- container
+ ~manim._config
+ ~manim.constants
+ ~manim.container
+ manim_directive
.. This is here so that sphinx doesn't complain about changelog.rst not being