Skip to content

armgit / manim

Public Imported from GitHub
0

A community-maintained Python framework for creating mathematical animations.

Improve sidebar structure of reference manual (#1778)

Benjamin Hackl17a3c637e8d9
diff --git a/docs/source/_templates/autosummary/class.rst b/docs/source/_templates/autosummary/class.rst
index 83d9ec1d2..8a0027edd 100644
--- a/docs/source/_templates/autosummary/class.rst
+++ b/docs/source/_templates/autosummary/class.rst
@@ -1,4 +1,6 @@
-{{ fullname | escape | underline}}
+{{ name | escape | underline}}
+
+Qualified name: ``{{ fullname | escape }}``
.. currentmodule:: {{ module }}
diff --git a/docs/source/_templates/autosummary/module.rst b/docs/source/_templates/autosummary/module.rst
index 54a7dfafc..d0a10c34c 100644
--- a/docs/source/_templates/autosummary/module.rst
+++ b/docs/source/_templates/autosummary/module.rst
@@ -1,4 +1,4 @@
-{{ fullname | escape | underline }}
+{{ name | escape | underline }}
.. currentmodule:: {{ fullname }}
diff --git a/docs/source/contributing/development.rst b/docs/source/contributing/development.rst
index 529119a08..d1b45c804 100644
--- a/docs/source/contributing/development.rst
+++ b/docs/source/contributing/development.rst
@@ -114,7 +114,7 @@ Develop your contribution
Update the docstrings (the text in triple quotation marks) of any functions
or classes you change and include them with any new functions you add.
- See the :doc:`documentation guide <documentation>` for more information about how we
+ See the :doc:`documentation guide <docstrings>` for more information about how we
prefer our code to be documented. The content of the docstrings will be
rendered in the :doc:`reference manual <../reference>`.
@@ -124,7 +124,7 @@ Develop your contribution
to the documentation!
.. autosummary::
- :toctree: reference
+ :toctree: ../reference
manim_directive
diff --git a/docs/source/contributing/reference/manim_directive.ManimDirective.rst b/docs/source/contributing/reference/manim_directive.ManimDirective.rst
deleted file mode 100644
index 171d574ed..000000000
--- a/docs/source/contributing/reference/manim_directive.ManimDirective.rst
+++ /dev/null
@@ -1,28 +0,0 @@
-manim\_directive.ManimDirective
-===============================
-
-.. currentmodule:: manim_directive
-
-.. autoclass:: ManimDirective
- :show-inheritance:
- :members:
-
-
- .. rubric:: Methods
-
- .. autosummary::
- :nosignatures:
-
- ~ManimDirective.run
-
-
- .. rubric:: Attributes
-
- .. autosummary::
-
- ~ManimDirective.final_argument_whitespace
- ~ManimDirective.has_content
- ~ManimDirective.option_spec
- ~ManimDirective.optional_arguments
- ~ManimDirective.required_arguments
-
\ No newline at end of file
diff --git a/docs/source/contributing/reference/manim_directive.rst b/docs/source/contributing/reference/manim_directive.rst
deleted file mode 100644
index 1f40a739a..000000000
--- a/docs/source/contributing/reference/manim_directive.rst
+++ /dev/null
@@ -1,44 +0,0 @@
-manim\_directive
-================
-
-.. currentmodule:: manim_directive
-
-.. automodule:: manim_directive
-
-
-
-
-
-
-
- .. rubric:: Classes
-
- .. autosummary::
- :toctree: .
- :nosignatures:
-
- ManimDirective
-
- skip_manim_node
-
-
-
-
-
-
- .. rubric:: Functions
-
-
- .. autofunction:: depart
- .. autofunction:: process_name_list
- .. autofunction:: setup
- .. autofunction:: visit
-
-
-
-
-
-
-
-
-
diff --git a/docs/source/contributing/reference/manim_directive.skip_manim_node.rst b/docs/source/contributing/reference/manim_directive.skip_manim_node.rst
deleted file mode 100644
index 447ed1b15..000000000
--- a/docs/source/contributing/reference/manim_directive.skip_manim_node.rst
+++ /dev/null
@@ -1,32 +0,0 @@
-manim\_directive.skip\_manim\_node
-==================================
-
-.. currentmodule:: manim_directive
-
-.. autoclass:: skip_manim_node
- :show-inheritance:
- :members:
-
-
- .. rubric:: Methods
-
- .. autosummary::
- :nosignatures:
-
-
-
- .. rubric:: Attributes
-
- .. autosummary::
-
- ~skip_manim_node.basic_attributes
- ~skip_manim_node.child_text_separator
- ~skip_manim_node.document
- ~skip_manim_node.known_attributes
- ~skip_manim_node.line
- ~skip_manim_node.list_attributes
- ~skip_manim_node.local_attributes
- ~skip_manim_node.parent
- ~skip_manim_node.source
- ~skip_manim_node.tagname
-
\ No newline at end of file
diff --git a/docs/source/reference.rst b/docs/source/reference.rst
index 4848a7d1b..e370f5580 100644
--- a/docs/source/reference.rst
+++ b/docs/source/reference.rst
@@ -8,226 +8,12 @@ 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.polyhedra
- ~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.style_utils
- ~mobject.svg.svg_path
- ~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
-
-**Mobject** Inheritance Graph
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. inheritance-diagram::
- manim.mobject.changing
- manim.mobject.coordinate_systems
- manim.mobject.frame
- manim.mobject.functions
- manim.mobject.geometry
- manim.mobject.graph
- manim.mobject.logo
- 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_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.style_utils
- manim.mobject.svg.svg_path
- 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
- :parts: 1
- :top-classes: manim.mobject.mobject.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
-
-**Scene** Inheritance Graph
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. inheritance-diagram::
- 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
- :parts: 1
- :top-classes: manim.scene.scene.Scene, manim.scene.scene.RerunSceneHandler
-
-
-**********
-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.transform_matching_parts
- ~animation.update
-
-**Animation** Inheritance Graph
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. inheritance-diagram::
- 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.transform_matching_parts
- manim.animation.update
- :parts: 1
- :top-classes: manim.animation.animation.Animation
-
-
-*******
-Cameras
-*******
-
-.. autosummary::
- :toctree: reference
-
- ~camera.camera
- ~camera.mapping_camera
- ~camera.moving_camera
- ~camera.multi_camera
- ~camera.three_d_camera
-
-**Camera** Inheritance Graph
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. 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
-
-*************
-Configuration
-*************
-
-.. autosummary::
- :toctree: reference
-
- ~_config
- ~_config.utils
- ~_config.logger_utils
-
-
-*********
-Utilities
-*********
-
-.. autosummary::
- :toctree: reference
-
- ~utils.bezier
- ~utils.color
- ~utils.config_ops
- ~utils.deprecation
- ~utils.hashing
- ~utils.ipython_magic
- ~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
+.. toctree::
+ :maxdepth: 3
+
+ reference_index/animations
+ reference_index/cameras
+ reference_index/configuration
+ reference_index/mobjects
+ reference_index/scenes
+ reference_index/utilities_misc
diff --git a/docs/source/reference_index/animations.rst b/docs/source/reference_index/animations.rst
new file mode 100644
index 000000000..c4bc6e6fd
--- /dev/null
+++ b/docs/source/reference_index/animations.rst
@@ -0,0 +1,48 @@
+Animations
+==========
+
+
+Inheritance Graph
+-----------------
+
+.. inheritance-diagram::
+ 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.transform_matching_parts
+ manim.animation.update
+ :parts: 1
+ :top-classes: manim.animation.animation.Animation
+
+
+Module Index
+------------
+
+.. currentmodule:: manim
+
+.. 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.transform_matching_parts
+ ~animation.update
+
+
diff --git a/docs/source/reference_index/cameras.rst b/docs/source/reference_index/cameras.rst
new file mode 100644
index 000000000..f5d6ec7b5
--- /dev/null
+++ b/docs/source/reference_index/cameras.rst
@@ -0,0 +1,29 @@
+Cameras
+=======
+
+Inheritance Graph
+-----------------
+
+.. 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
+
+
+Module Index
+------------
+
+.. currentmodule:: manim
+
+.. autosummary::
+ :toctree: ../reference
+
+ ~camera.camera
+ ~camera.mapping_camera
+ ~camera.moving_camera
+ ~camera.multi_camera
+ ~camera.three_d_camera
diff --git a/docs/source/reference_index/configuration.rst b/docs/source/reference_index/configuration.rst
new file mode 100644
index 000000000..966beb7f2
--- /dev/null
+++ b/docs/source/reference_index/configuration.rst
@@ -0,0 +1,16 @@
+Configuration
+=============
+
+Module Index
+------------
+
+.. currentmodule:: manim
+
+.. autosummary::
+ :toctree: ../reference
+
+ ~_config
+ ~_config.utils
+ ~_config.logger_utils
+
+
diff --git a/docs/source/reference_index/mobjects.rst b/docs/source/reference_index/mobjects.rst
new file mode 100644
index 000000000..9776f2449
--- /dev/null
+++ b/docs/source/reference_index/mobjects.rst
@@ -0,0 +1,78 @@
+Mobjects
+========
+
+Inheritance Graph
+-----------------
+
+.. inheritance-diagram::
+ manim.mobject.changing
+ manim.mobject.coordinate_systems
+ manim.mobject.frame
+ manim.mobject.functions
+ manim.mobject.geometry
+ manim.mobject.graph
+ manim.mobject.logo
+ 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_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.style_utils
+ manim.mobject.svg.svg_path
+ 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
+ :parts: 1
+ :top-classes: manim.mobject.mobject.Mobject
+
+
+
+Module Index
+------------
+
+.. currentmodule:: manim
+
+.. 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.polyhedra
+ ~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.style_utils
+ ~mobject.svg.svg_path
+ ~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
+
diff --git a/docs/source/reference_index/scenes.rst b/docs/source/reference_index/scenes.rst
new file mode 100644
index 000000000..5ac41a897
--- /dev/null
+++ b/docs/source/reference_index/scenes.rst
@@ -0,0 +1,38 @@
+Scenes
+======
+
+
+Inheritance Graph
+-----------------
+
+.. inheritance-diagram::
+ 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
+ :parts: 1
+ :top-classes: manim.scene.scene.Scene, manim.scene.scene.RerunSceneHandler
+
+
+Module Index
+------------
+
+.. currentmodule:: manim
+
+.. 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
diff --git a/docs/source/reference_index/utilities_misc.rst b/docs/source/reference_index/utilities_misc.rst
new file mode 100644
index 000000000..ce1e3e50e
--- /dev/null
+++ b/docs/source/reference_index/utilities_misc.rst
@@ -0,0 +1,29 @@
+Utilities and other modules
+===========================
+
+Module Index
+------------
+
+.. currentmodule:: manim
+
+.. autosummary::
+ :toctree: ../reference
+
+ constants
+ ~utils.bezier
+ ~utils.color
+ ~utils.config_ops
+ ~utils.deprecation
+ ~utils.hashing
+ ~utils.ipython_magic
+ ~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