Added support for Manim type aliases in Sphinx docs + Added new TypeAliases

docs/source/conf.py

@@ -11,6 +11,7 @@
 from pathlib import Path
 
 import manim
+from manim.utils.docbuild.module_parsing import get_typing_docs
 
 # -- Path setup --------------------------------------------------------------
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -44,6 +45,7 @@
     "sphinxext.opengraph",
     "manim.utils.docbuild.manim_directive",
     "manim.utils.docbuild.autocolor_directive",
+    "manim.utils.docbuild.autotyping_directive",
     "sphinx.ext.graphviz",
     "sphinx.ext.inheritance_diagram",
     "sphinxcontrib.programoutput",
@@ -55,6 +57,12 @@
 
 # generate documentation from type hints
 autodoc_typehints = "description"
+autodoc_type_aliases = {
+    alias_name: f"~manim.typing.{alias_name}"
+    for category_dict in get_typing_docs().values()
+    for alias_dict in category_dict.values()
+    for alias_name in alias_dict.keys()
+}
 autoclass_content = "both"
 
 # controls whether functions documented by the autofunction directive

docs/source/reference_index/utilities_misc.rst

@@ -9,6 +9,7 @@ Module Index
 .. autosummary::
    :toctree: ../reference
 
+   typing
    constants
    ~utils.bezier
    ~utils.color

manim/__init__.py

@@ -16,6 +16,7 @@
 from .utils.commands import *
 
 # isort: on
+import numpy as np
 
 from .animation.animation import *
 from .animation.changing import *

manim/_config/cli_colors.py

@@ -4,6 +4,8 @@
 
 from cloup import Context, HelpFormatter, HelpTheme, Style
 
+__all__ = ["parse_cli_ctx"]
+
 
 def parse_cli_ctx(parser: configparser.SectionProxy) -> Context:
     formatter_settings: dict[str, str | int] = {

manim/_config/logger_utils.py

@@ -26,6 +26,8 @@
 if TYPE_CHECKING:
     from pathlib import Path
 
+__all__ = ["make_logger", "parse_theme", "set_file_logger", "JSONFormatter"]
+
 HIGHLIGHTED_KEYWORDS = [  # these keywords are highlighted specially
     "Played",
     "animations",

manim/_config/utils.py

@@ -33,6 +33,8 @@
 from ..utils.color import ManimColor
 from ..utils.tex import TexTemplate, TexTemplateFromFile
 
+__all__ = ["config_file_paths", "make_config_parser", "ManimConfig", "ManimFrame"]
+
 
 def config_file_paths() -> list[Path]:
     """The paths where ``.cfg`` files will be searched for.

manim/animation/speedmodifier.py

@@ -13,6 +13,8 @@
 from ..mobject.mobject import Mobject, Updater, _AnimationBuilder
 from ..scene.scene import Scene
 
+__all__ = ["ChangeSpeed"]
+
 
 class ChangeSpeed(Animation):
     """Modifies the speed of passed animation.

manim/cli/cfg/group.py

@@ -26,6 +26,17 @@
 """
 RICH_NON_STYLE_ENTRIES: str = ["log.width", "log.height", "log.timestamps"]
 
+__all__ = [
+    "value_from_string",
+    "value_from_string",
+    "is_valid_style",
+    "replace_keys",
+    "cfg",
+    "write",
+    "show",
+    "export",
+]
+
 
 def value_from_string(value: str) -> str | int | bool:
     """Extracts the literal of proper datatype from a string.

manim/cli/checkhealth/checks.py

@@ -10,6 +10,8 @@
 
 from ..._config import config
 
+__all__ = ["HEALTH_CHECKS"]
+
 HEALTH_CHECKS = []
 
 

manim/cli/checkhealth/commands.py

@@ -12,6 +12,8 @@
 
 from .checks import HEALTH_CHECKS
 
+__all__ = ["checkhealth"]
+
 
 @cloup.command(
     context_settings=None,

manim/cli/init/commands.py

@@ -30,6 +30,8 @@
     "resolution": (854, 480),
 }
 
+__all__ = ["select_resolution", "update_cfg", "project", "scene"]
+
 
 def select_resolution():
     """Prompts input of type click.Choice from user. Presents options from QUALITIES constant.

manim/cli/plugins/commands.py

@@ -12,6 +12,8 @@
 from ...constants import CONTEXT_SETTINGS, EPILOG
 from ...plugins.plugins_flags import list_plugins
 
+__all__ = ["plugins"]
+
 
 @cloup.command(
     context_settings=CONTEXT_SETTINGS,

manim/cli/render/commands.py

@@ -26,6 +26,8 @@
 from .output_options import output_options
 from .render_options import render_options
 
+__all__ = ["render"]
+
 
 @cloup.command(
     context_settings=None,

manim/cli/render/ease_of_access_options.py

@@ -2,6 +2,8 @@
 
 from cloup import Choice, option, option_group
 
+__all__ = ["ease_of_access_options"]
+
 ease_of_access_options = option_group(
     "Ease of access options",
     option(

manim/cli/render/global_options.py

@@ -6,6 +6,8 @@
 
 from ... import logger
 
+__all__ = ["global_options"]
+
 
 def validate_gui_location(ctx, param, value):
     if value:

manim/cli/render/output_options.py

@@ -2,6 +2,8 @@
 
 from cloup import IntRange, Path, option, option_group
 
+__all__ = ["output_options"]
+
 output_options = option_group(
     "Output options",
     option(

manim/cli/render/render_options.py

@@ -8,6 +8,8 @@
 
 from ... import logger
 
+__all__ = ["render_options"]
+
 
 def validate_scene_range(ctx, param, value):
     try:

manim/gui/gui.py

@@ -13,6 +13,8 @@
 from .. import __version__, config
 from ..utils.module_ops import scene_classes_from_file
 
+__all__ = ["configure_pygui"]
+
 if dearpygui_imported:
     dpg.create_context()
     window = dpg.generate_uuid()

manim/mobject/opengl/opengl_compatibility.py

@@ -10,6 +10,8 @@
 
 from ...constants import RendererType
 
+__all__ = ["ConvertToOpenGL"]
+
 
 class ConvertToOpenGL(ABCMeta):
     """Metaclass for swapping (V)Mobject with its OpenGL counterpart at runtime

manim/mobject/opengl/opengl_geometry.py

@@ -28,6 +28,32 @@
 DEFAULT_ARROW_TIP_LENGTH = 0.35
 DEFAULT_ARROW_TIP_WIDTH = 0.35
 
+__all__ = [
+    "OpenGLTipableVMobject",
+    "OpenGLArc",
+    "OpenGLArcBetweenPoints",
+    "OpenGLCurvedArrow",
+    "OpenGLCurvedDoubleArrow",
+    "OpenGLCircle",
+    "OpenGLDot",
+    "OpenGLEllipse",
+    "OpenGLAnnularSector",
+    "OpenGLSector",
+    "OpenGLAnnulus",
+    "OpenGLLine",
+    "OpenGLDashedLine",
+    "OpenGLTangentLine",
+    "OpenGLElbow",
+    "OpenGLArrow",
+    "OpenGLVector",
+    "OpenGLDoubleArrow",
+    "OpenGLCubicBezier",
+    "OpenGLPolygon",
+    "OpenGLRegularPolygon",
+    "OpenGLTriangle",
+    "OpenGLArrowTip",
+]
+
 
 class OpenGLTipableVMobject(OpenGLVMobject):
     """

manim/mobject/opengl/opengl_image_mobject.py

@@ -13,6 +13,8 @@
 from manim.mobject.opengl.opengl_surface import OpenGLSurface, OpenGLTexturedSurface
 from manim.utils.images import get_full_raster_image_path
 
+__all__ = ["OpenGLImageMobject"]
+
 
 class OpenGLImageMobject(OpenGLTexturedSurface):
     def __init__(

manim/mobject/opengl/opengl_mobject.py

@@ -56,6 +56,9 @@ def wrapper(self):
     return wrapper
 
 
+__all__ = ["OpenGLMobject", "OpenGLGroup", "OpenGLPoint", "_AnimationBuilder"]
+
+
 class OpenGLMobject:
     """Mathematical Object: base class for objects that can be displayed on screen.
 

manim/mobject/opengl/opengl_point_cloud_mobject.py

@@ -12,6 +12,8 @@
 from manim.utils.config_ops import _Uniforms
 from manim.utils.iterables import resize_with_interpolation
 
+__all__ = ["OpenGLPMobject", "OpenGLPGroup", "OpenGLPMPoint"]
+
 
 class OpenGLPMobject(OpenGLMobject):
     shader_folder = "true_dot"

manim/mobject/opengl/opengl_surface.py

@@ -17,6 +17,8 @@
 from manim.utils.iterables import listify
 from manim.utils.space_ops import normalize_along_axis
 
+__all__ = ["OpenGLSurface", "OpenGLTexturedSurface"]
+
 
 class OpenGLSurface(OpenGLMobject):
     r"""Creates a Surface.

manim/mobject/opengl/opengl_three_dimensions.py

@@ -5,6 +5,8 @@
 from manim.mobject.opengl.opengl_surface import OpenGLSurface
 from manim.mobject.opengl.opengl_vectorized_mobject import OpenGLVGroup, OpenGLVMobject
 
+__all__ = ["OpenGLSurfaceMesh"]
+
 
 class OpenGLSurfaceMesh(OpenGLVGroup):
     def __init__(

manim/mobject/opengl/opengl_vectorized_mobject.py

@@ -34,6 +34,15 @@
     z_to_vector,
 )
 
+__all__ = [
+    "triggers_refreshed_triangulation",
+    "OpenGLVMobject",
+    "OpenGLVGroup",
+    "OpenGLVectorizedPoint",
+    "OpenGLCurvesAsSubmobjects",
+    "OpenGLDashedVMobject",
+]
+
 
 def triggers_refreshed_triangulation(func):
     @wraps(func)

manim/mobject/svg/brace.py

@@ -24,6 +24,8 @@
 from ...utils.color import BLACK
 from ..svg.svg_mobject import VMobjectFromSVGPath
 
+__all__ = ["Brace", "BraceBetweenPoints", "BraceLabel", "ArcBrace"]
+
 
 class Brace(VMobjectFromSVGPath):
     """Takes a mobject and draws a brace adjacent to it.

manim/mobject/text/code_mobject.py

@@ -26,6 +26,8 @@
 from manim.mobject.types.vectorized_mobject import VGroup
 from manim.utils.color import WHITE
 
+__all__ = ["Code"]
+
 
 class Code(VGroup):
     """A highlighted source code listing.

manim/mobject/text/numbers.py

@@ -18,6 +18,8 @@
 
 string_to_mob_map = {}
 
+__all__ = ["DecimalNumber", "Integer", "Variable"]
+
 
 class DecimalNumber(VMobject, metaclass=ConvertToOpenGL):
     """An mobject representing a decimal number.

manim/mobject/text/text_mobject.py

@@ -79,6 +79,8 @@ def construct(self):
 DEFAULT_LINE_SPACING_SCALE = 0.3
 TEXT2SVG_ADJUSTMENT_FACTOR = 4.8
 
+__all__ = ["Text", "Paragraph", "MarkupText", "register_font"]
+
 
 def remove_invisible_chars(mobject: SVGMobject) -> SVGMobject:
     """Function to remove unwanted invisible characters from some mobjects.

manim/mobject/types/image_mobject.py

@@ -19,6 +19,8 @@
 from ...utils.color import WHITE, ManimColor, color_to_int_rgb
 from ...utils.images import change_to_rgba_array, get_full_raster_image_path
 
+__all__ = ["ImageMobject", "ImageMobjectFromCamera"]
+
 
 class AbstractImageMobject(Mobject):
     """

manim/mobject/types/point_cloud_mobject.py

@@ -23,6 +23,8 @@
 )
 from ...utils.iterables import stretch_array_to_length
 
+__all__ = ["PMobject", "Mobject1D", "Mobject2D", "PGroup", "PointCloudDot", "Point"]
+
 
 class PMobject(Mobject, metaclass=ConvertToOpenGL):
     """A disc made of a cloud of Dots

manim/mobject/types/vectorized_mobject.py

@@ -74,6 +74,16 @@
 # - Think about length of self.points.  Always 0 or 1 mod 4?
 #   That's kind of weird.
 
+__all__ = [
+    "VMobject",
+    "VGroup",
+    "VDict",
+    "VectorizedPoint",
+    "CurvesAsSubmobjects",
+    "VectorizedPoint",
+    "DashedVMobject",
+]
+
 
 class VMobject(Mobject):
     """A vectorized mobject.

manim/renderer/cairo_renderer.py

@@ -20,6 +20,8 @@
     from manim.animation.animation import Animation
     from manim.scene.scene import Scene
 
+__all__ = ["CairoRenderer"]
+
 
 class CairoRenderer:
     """A renderer using Cairo.

manim/renderer/opengl_renderer.py

@@ -39,6 +39,8 @@
     render_opengl_vectorized_mobject_stroke,
 )
 
+__all__ = ["OpenGLCamera", "OpenGLRenderer"]
+
 
 class OpenGLCamera(OpenGLMobject):
     euler_angles = _Data()

manim/renderer/opengl_renderer_window.py

@@ -7,6 +7,8 @@
 
 from .. import __version__, config
 
+__all__ = ["Window"]
+
 
 class Window(PygletWindow):
     fullscreen = False

manim/renderer/shader_wrapper.py

@@ -15,6 +15,8 @@
 # of a dict holding all the relevant information
 # to that shader
 
+__all__ = ["ShaderWrapper"]
+
 
 def get_shader_dir():
     return Path(__file__).parent / "shaders"