Improve/extend reference manual (#438)

* include _all_ modules in reference manual

* improve table of contents in sidebar

* modify class template: no longer use separate files for all methods

* no signatures in table overview

* rewrite code_mobject module docstring

* add one-line module docstrings

* rudimentary documentation of changing.py

* add example to ValueTracker

* clarify that Text does not use LaTeX

Co-authored-by: Leo Torres <[email protected]>
Co-authored-by: Hugues Devimeux <[email protected]>

Author: 3 people

docs/source/_templates/autosummary/class.rst

@@ -3,14 +3,14 @@
 .. currentmodule:: {{ module }}
 
 .. autoclass:: {{ objname }}
+   :members:
 
    {% block methods %}
    {%- if methods %}
    .. rubric:: {{ _('Methods') }}
 
    .. autosummary::
       :nosignatures:
-      :toctree: .
       {% for item in methods if item != '__init__' and item not in inherited_members %}
       ~{{ name }}.{{ item }}
       {%- endfor %}

docs/source/reference.rst

@@ -8,46 +8,85 @@ the :doc:`changelog`.
 
 .. warning:: The pages linked to here are currently a work in progress.
 
-
-List of Modules
-***************
-
 .. currentmodule:: manim
 
-**Mathematical Objects**
+********************
+Mathematical Objects
+********************
 
 .. autosummary::
    :toctree: reference
 
-   ~mobject.mobject
-   ~mobject.types.vectorized_mobject
+   ~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
 
 
-**Scenes**
+******
+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.moving_camera_scene
 
 
-**Animations**
+**********
+Animations
+**********
 
 .. autosummary::
    :toctree: reference
 
    ~animation.animation
+   ~animation.composition
    ~animation.creation
    ~animation.fading
-   ~animation.composition
+   ~animation.growing
+   ~animation.indication
+   ~animation.movement
+   ~animation.numbers
+   ~animation.rotation
+   ~animation.specialized
+   ~animation.transform
+   ~animation.update
 
 
-**Cameras**
+*******
+Cameras
+*******
 
 .. autosummary::
    :toctree: reference
@@ -59,7 +98,32 @@ List of Modules
    ~camera.three_d_camera
 
 
-**Other modules**
+*********
+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
+
+
+*************
+Other modules
+*************
 
 .. autosummary::
    :toctree: reference

manim/animation/growing.py

@@ -1,3 +1,5 @@
+"""Animations that grow mobjects."""
+
 __all__ = [
     "GrowFromPoint",
     "GrowFromCenter",

manim/animation/indication.py

@@ -1,3 +1,5 @@
+"""Animations drawing attention to particular mobjects."""
+
 __all__ = [
     "FocusOn",
     "Indicate",

manim/animation/movement.py

@@ -1,3 +1,5 @@
+"""Animations related to movement."""
+
 __all__ = [
     "Homotopy",
     "SmoothedVectorizedHomotopy",

manim/animation/numbers.py

@@ -1,3 +1,5 @@
+"""Animations for changing numbers."""
+
 __all__ = ["ChangingDecimal", "ChangeDecimalToValue"]
 
 

manim/animation/rotation.py

@@ -1,3 +1,5 @@
+"""Animations related to rotation."""
+
 __all__ = ["Rotating", "Rotate"]
 
 

manim/animation/specialized.py

@@ -1,3 +1,5 @@
+"""Animations for highly specialiced applications."""
+
 __all__ = ["MoveCar", "Broadcast"]
 
 

manim/animation/transform.py

@@ -1,3 +1,5 @@
+"""Animations transforming one mobject into another."""
+
 __all__ = [
     "Transform",
     "ReplacementTransform",

manim/animation/update.py

@@ -1,3 +1,5 @@
+"""Animations that update mobjects."""
+
 __all__ = ["UpdateFromFunc", "UpdateFromAlphaFunc", "MaintainPositionRelativeTo"]