refactor(lib): change how manim API is imported

.pre-commit-config.yaml

@@ -23,6 +23,18 @@ repos:
   rev: 23.9.1
   hooks:
   - id: black
+- repo: https://github.com/adamchainz/blacken-docs
+  rev: 1.16.0
+  hooks:
+  - id: blacken-docs
+    additional_dependencies:
+    - black==23.9.1
+- repo: https://github.com/PyCQA/docformatter
+  rev: v1.7.5
+  hooks:
+  - id: docformatter
+    additional_dependencies: [tomli]
+    args: [--in-place, --config, ./pyproject.toml]
 - repo: https://github.com/astral-sh/ruff-pre-commit
   rev: v0.0.292
   hooks:

README.md

@@ -95,9 +95,11 @@ Wrap a series of animations between `self.start_loop()` and `self.stop_loop()` w
 # example.py
 
 from manim import *
+
 # or: from manimlib import *
 from manim_slides import Slide
 
+
 class BasicExample(Slide):
     def construct(self):
         circle = Circle(radius=3, color=BLUE)

custom_config.yml

@@ -0,0 +1,2 @@
+style:
+  background_color: "#000000"

docs/source/conf.py

@@ -23,12 +23,18 @@
     "nbsphinx",
     "myst_parser",
     "sphinxext.opengraph",
+    # "sphinx_autodoc_typehints",
     "sphinx_click",
     "sphinx_copybutton",
     # Custom
     "manim_slides.docs.manim_slides_directive",
 ]
 
+rst_prolog = """
+.. role:: python(code)
+    :language: python
+"""
+
 typehints_defaults = "comma"
 typehints_use_signature = True
 typehints_use_signature_return = True
@@ -41,6 +47,8 @@
 templates_path = ["_templates"]
 exclude_patterns = []
 
+# Removes the 'package.module' part from package.module.Class
+add_module_names = False
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

docs/source/docutils.conf

@@ -0,0 +1,2 @@
+[restructuredtext parser]
+syntax_highlight = short

docs/source/reference/api.md

@@ -6,22 +6,36 @@ and `ThreeDSlide`, which are subclasses of `Scene` and `ThreeDScene` from Manim.
 Therefore, we only document here the methods we think the end-user will ever
 use, not the methods used internally when rendering.
 
+## Slide
+
 ```{eval-rst}
-.. autoclass:: manim_slides.Slide
+.. autoclass:: manim_slides.slide.Slide
     :members:
         add_to_canvas,
         canvas,
         canvas_mobjects,
         end_loop,
         mobjects_without_canvas,
         next_slide,
-        pause,
         remove_from_canvas,
         start_loop,
         wait_time_between_slides,
         wipe,
         zoom,
+```
+
+## 3D Slide
 
-.. autoclass:: manim_slides.ThreeDSlide
+```{eval-rst}
+.. autoclass:: manim_slides.slide.ThreeDSlide
+    :members:
+```
+
+## Animations
+
+```{eval-rst}
+.. automodule:: manim_slides.slide.animation
     :members:
+        Wipe,
+        Zoom,
 ```

example.py

@@ -1,17 +1,13 @@
 # flake8: noqa: F403, F405
 # type: ignore
-import sys
 
-if "manimlib" in sys.modules:
-    from manimlib import *
+from manim_slides import Slide, ThreeDSlide
+from manim_slides.slide import MANIM, MANIMGL
 
-    MANIMGL = True
-else:
+if MANIM:
     from manim import *
-
-    MANIMGL = False
-
-from manim_slides import Slide, ThreeDSlide
+elif MANIMGL:
+    from manimlib import *
 
 
 class BasicExample(Slide):
@@ -27,7 +23,6 @@ def construct(self):
         self.end_loop()  # This will loop until user inputs a key
 
         self.play(dot.animate.move_to(ORIGIN))
-        self.next_slide()  # Waits user to press continue to go to the next slide
 
 
 class MultipleAnimationsInLastSlide(Slide):
@@ -46,8 +41,6 @@ def construct(self):
         self.play(dot.animate.move_to(LEFT))
         self.play(dot.animate.move_to(DOWN))
 
-        self.next_slide()
-
 
 class TestFileTooLong(Slide):
     """This is used to check against solution for issue #123."""
@@ -64,8 +57,6 @@ def construct(self):
             self.play(dot.animate.move_to(direction), run_time=0.1)
             self.play(dot.animate.move_to(ORIGIN), run_time=0.1)
 
-        self.next_slide()
-
 
 class ConvertExample(Slide):
     """WARNING: this example does not seem to work with ManimGL."""
@@ -207,7 +198,7 @@ def construct(self):
             language="console",
         ).shift(DOWN)
 
-        self.play(self.wipe(title, code))
+        self.wipe(title, code)
         self.next_slide()
 
         self.play(FadeIn(step, shift=RIGHT))
@@ -311,11 +302,7 @@ def construct(self):
     # [manimgl-3d]
     # WARNING: 3b1b's manim change how ThreeDScene work,
     # this is why things have to be managed differently.
-    class ThreeDExample(Slide):
-        CONFIG = {
-            "camera_class": ThreeDCamera,
-        }
-
+    class ThreeDExample(ThreeDSlide):
         def construct(self):
             axes = ThreeDAxes()
             circle = Circle(radius=3, color=BLUE)
@@ -327,7 +314,6 @@ def construct(self):
             frame.set_euler_angles(
                 theta=30 * DEGREES,
                 phi=75 * DEGREES,
-                gamma=0,
             )
 
             self.play(GrowFromCenter(circle))

manim_slides/__main__.py

@@ -6,7 +6,7 @@
 
 from .__version__ import __version__
 from .convert import convert
-from .logger import make_logger
+from .logger import logger
 from .present import list_scenes, present
 from .wizard import init, wizard
 
@@ -27,7 +27,6 @@ def cli(notify_outdated_version: bool) -> None:
 
     If no command is specified, defaults to `present`.
     """
-    logger = make_logger()
     # Code below is mostly a copy from:
     # https://github.com/ManimCommunity/manim/blob/main/manim/cli/render/commands.py
     if notify_outdated_version:

manim_slides/config.py

@@ -115,7 +115,7 @@ def dispatch(key: PositiveInt) -> None:
 
 
 class Config(BaseModel):  # type: ignore[misc]
-    """General Manim Slides config"""
+    """General Manim Slides config."""
 
     keys: Keys = Keys()
 
@@ -207,9 +207,7 @@ def to_file(self, path: Path) -> None:
             f.write(self.model_dump_json(indent=2))
 
     def copy_to(self, folder: Path, use_cached: bool = True) -> "PresentationConfig":
-        """
-        Copy the files to a given directory.
-        """
+        """Copy the files to a given directory."""
         for slide_config in self.slides:
             file = slide_config.file
             rev_file = slide_config.rev_file

manim_slides/convert.py

@@ -65,9 +65,7 @@ def validate_config_option(
 
 
 def file_to_data_uri(file: Path) -> str:
-    """
-    Reads a video and returns the corresponding data-uri.
-    """
+    """Reads a video and returns the corresponding data-uri."""
     b64 = b64encode(file.read_bytes()).decode("ascii")
     mime_type = mimetypes.guess_type(file)[0] or "video/mp4"
 
@@ -84,9 +82,11 @@ def convert_to(self, dest: Path) -> None:
         raise NotImplementedError
 
     def load_template(self) -> str:
-        """Returns the template as a string.
+        """
+        Returns the template as a string.
 
-        An empty string is returned if no template is used."""
+        An empty string is returned if no template is used.
+        """
         return ""
 
     def open(self, file: Path) -> Any:
@@ -358,7 +358,8 @@ def open(self, file: Path) -> bool:
         return webbrowser.open(file.absolute().as_uri())
 
     def convert_to(self, dest: Path) -> None:
-        """Converts this configuration into a RevealJS HTML presentation, saved to DEST."""
+        """Converts this configuration into a RevealJS HTML presentation, saved to
+        DEST."""
         if self.data_uri:
             assets_dir = Path("")  # Actually we won't care.
         else:
@@ -632,9 +633,7 @@ def convert(
     config_options: Dict[str, str],
     template: Optional[Path],
 ) -> None:
-    """
-    Convert SCENE(s) into a given format and writes the result in DEST.
-    """
+    """Convert SCENE(s) into a given format and writes the result in DEST."""
 
     presentation_configs = get_scenes_presentation_config(scenes, folder)
 

manim_slides/docs/manim_slides_directive.py

@@ -138,8 +138,9 @@ def construct(self):
 
 
 class SkipManimNode(nodes.Admonition, nodes.Element):
-    """Auxiliary node class that is used when the ``skip-manim-slides`` tag is
-    present or ``.pot`` files are being built.
+    """
+    Auxiliary node class that is used when the ``skip-manim-slides`` tag is present or
+    ``.pot`` files are being built.
 
     Skips rendering the manim-slides directive and outputs a placeholder instead.
     """
@@ -158,8 +159,9 @@ def depart(self, node):
 
 
 def process_name_list(option_input: str, reference_type: str) -> list[str]:
-    r"""Reformats a string of space separated class names
-    as a list of strings containing valid Sphinx references.
+    r"""
+    Reformats a string of space separated class names as a list of strings containing
+    valid Sphinx references.
 
     Tests
     -----
@@ -175,8 +177,8 @@ def process_name_list(option_input: str, reference_type: str) -> list[str]:
 
 
 class ManimSlidesDirective(Directive):
-    r"""The manim-slides directive, rendering videos while building
-    the documentation.
+    r"""
+    The manim-slides directive, rendering videos while building the documentation.
 
     See the module docstring for documentation.
     """

manim_slides/ipython/ipython_magic.py

@@ -59,8 +59,8 @@ def manim_slides(
         cell: Optional[str] = None,
         local_ns: Dict[str, Any] = {},
     ) -> None:
-        r"""Render Manim Slides contained in IPython cells.
-        Works as a line or cell magic.
+        r"""
+        Render Manim Slides contained in IPython cells. Works as a line or cell magic.
 
         .. note::
 
@@ -143,7 +143,6 @@ def construct(self):
             In case you want to hide the red box containing the output progress bar, the ``progress_bar`` config
             option should be set to ``None``. This can also be done by passing ``--progress_bar None`` as a
             CLI flag.
-
         """
         if cell:
             exec(cell, local_ns)

manim_slides/logger.py

@@ -1,5 +1,6 @@
 """
 Logger utils, mostly copied from Manim Community:
+
 https://github.com/ManimCommunity/manim/blob/d5b65b844b8ce8ff5151a2f56f9dc98cebbc1db4/manim/_config/logger_utils.py#L29-L101
 """
 
@@ -8,7 +9,7 @@
 from rich.console import Console
 from rich.logging import RichHandler
 
-__all__ = ["logger", "make_logger"]
+__all__ = ["logger"]
 
 HIGHLIGHTED_KEYWORDS = [  # these keywords are highlighted specially
     "Played",
@@ -29,9 +30,7 @@
 
 
 def make_logger() -> logging.Logger:
-    """
-    Make a logger similar to the one used by Manim.
-    """
+    """Make a logger similar to the one used by Manim."""
     RichHandler.KEYWORDS = HIGHLIGHTED_KEYWORDS
     rich_handler = RichHandler(
         show_time=True,
@@ -44,4 +43,6 @@ def make_logger() -> logging.Logger:
     return logger
 
 
+make_logger()
+
 logger = logging.getLogger("manim-slides")