wip: docs

docs/source/conf.py

@@ -41,6 +41,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/reference/examples.md

@@ -2,29 +2,26 @@
 
 Contents of `example.py`.
 
-Do not forget to import Manim Slides and Manim or ManimGL:
+Do not forget to import Manim Slides and Manim[^1]:
 
 ```python
 from manim import *
 from manim_slides import Slide, ThreeDSlide
 ```
 
-or
-
-```python
-from manimlib import *
-from manim_slides import Slide, ThreeDSlide
-```
-
 Then, each presentation, named `SCENE`, was generated with those two commands:
 
 ```bash
-manim example.py SCENE # or manimgl example SCENE
+manim example.py SCENE
 manim-slides convert SCENE scene.html -ccontrols=true
 ```
 
 where `-ccontrols=true` indicates that we want to display the blue navigation arrows.
 
+[^1]: While Manim Slides is compatible with ManimGL, writing scenes that both
+  render with Manim and ManimGL has become very hard, so the examples below
+  are only tested to work with Manim.
+
 ## Basic Example
 
 Basic example from quickstart.
@@ -42,10 +39,7 @@ Basic example from quickstart.
 
 ## 3D Example
 
-Example using 3D camera. As Manim and ManimGL handle 3D differently,
-definitions are slightly different.
-
-### With Manim
+Example using 3D camera.
 
 ```{eval-rst}
 .. manim-slides:: ../../../example.py:ThreeDExample
@@ -55,20 +49,7 @@ definitions are slightly different.
 .. literalinclude:: ../../../example.py
    :language: python
    :linenos:
-   :dedent: 4
-   :start-after: [manim-3d]
-   :end-before: [manim-3d]
-```
-
-### With ManimGL
-
-```{eval-rst}
-.. literalinclude:: ../../../example.py
-   :language: python
-   :linenos:
-   :dedent: 4
-   :start-after: [manimgl-3d]
-   :end-before: [manimgl-3d]
+   :pyobject: ThreeDExample
 ```
 
 ## Subclass Custom Scenes

example.py

@@ -1,13 +1,14 @@
 # flake8: noqa: F403, F405
 # type: ignore
-
+"""
+Examples of Slides generated with Manim and Manim Slides.
+
+The following examples are most likely not going to work with ManimGL,
+but Manim Slides still provides support for ManimGL, and should be fully
+compatible with it.
+"""
+from manim import *
 from manim_slides import Slide, ThreeDSlide
-from manim_slides.slide import MANIM, MANIMGL
-
-if MANIM:
-    from manim import *
-elif MANIMGL:
-    from manimlib import *
 
 
 class BasicExample(Slide):
@@ -258,94 +259,36 @@ def construct(self):
 
         self.play(Transform(square, learn_more_text))
 
+class ThreeDExample(ThreeDSlide):
+    def construct(self):
+        axes = ThreeDAxes()
+        circle = Circle(radius=3, color=BLUE)
+        dot = Dot(color=RED)
 
-# For ThreeDExample, things are different
-
-if not MANIMGL:
-    # [manim-3d]
-    class ThreeDExample(ThreeDSlide):
-        def construct(self):
-            axes = ThreeDAxes()
-            circle = Circle(radius=3, color=BLUE)
-            dot = Dot(color=RED)
-
-            self.add(axes)
-
-            self.set_camera_orientation(phi=75 * DEGREES, theta=30 * DEGREES)
-
-            self.play(GrowFromCenter(circle))
-            self.begin_ambient_camera_rotation(rate=75 * DEGREES / 4)
-
-            self.next_slide()
-
-            self.start_loop()
-            self.play(MoveAlongPath(dot, circle), run_time=4, rate_func=linear)
-            self.end_loop()
-
-            self.stop_ambient_camera_rotation()
-            self.move_camera(phi=75 * DEGREES, theta=30 * DEGREES)
-
-            self.play(dot.animate.move_to(ORIGIN))
-            self.next_slide()
-
-            self.play(dot.animate.move_to(RIGHT * 3))
-            self.next_slide()
-
-            self.start_loop()
-            self.play(MoveAlongPath(dot, circle), run_time=2, rate_func=linear)
-            self.end_loop()
-
-            self.play(dot.animate.move_to(ORIGIN))
-
-    # [manim-3d]
-else:
-    # [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,
-        }
-
-        def construct(self):
-            axes = ThreeDAxes()
-            circle = Circle(radius=3, color=BLUE)
-            dot = Dot(color=RED)
-
-            self.add(axes)
-
-            frame = self.camera.frame
-            frame.set_euler_angles(
-                theta=30 * DEGREES,
-                phi=75 * DEGREES,
-                gamma=0,
-            )
-
-            self.play(GrowFromCenter(circle))
+        self.add(axes)
 
-            def updater(m, dt):
-                return m.increment_theta((75 * DEGREES / 4) * dt)
+        self.set_camera_orientation(phi=75 * DEGREES, theta=30 * DEGREES)
 
-            frame.add_updater(updater)
+        self.play(GrowFromCenter(circle))
+        self.begin_ambient_camera_rotation(rate=75 * DEGREES / 4)
 
-            self.next_slide()
+        self.next_slide()
 
-            self.start_loop()
-            self.play(MoveAlongPath(dot, circle), run_time=4, rate_func=linear)
-            self.end_loop()
+        self.start_loop()
+        self.play(MoveAlongPath(dot, circle), run_time=4, rate_func=linear)
+        self.end_loop()
 
-            frame.remove_updater(updater)
-            self.play(frame.animate.set_theta(30 * DEGREES))
-            self.play(dot.animate.move_to(ORIGIN))
-            self.next_slide()
+        self.stop_ambient_camera_rotation()
+        self.move_camera(phi=75 * DEGREES, theta=30 * DEGREES)
 
-            self.play(dot.animate.move_to(RIGHT * 3))
-            self.next_slide()
+        self.play(dot.animate.move_to(ORIGIN))
+        self.next_slide()
 
-            self.start_loop()
-            self.play(MoveAlongPath(dot, circle), run_time=2, rate_func=linear)
-            self.end_loop()
+        self.play(dot.animate.move_to(RIGHT * 3))
+        self.next_slide()
 
-            self.play(dot.animate.move_to(ORIGIN))
+        self.start_loop()
+        self.play(MoveAlongPath(dot, circle), run_time=2, rate_func=linear)
+        self.end_loop()
 
-    # [manimgl-3d]
+        self.play(dot.animate.move_to(ORIGIN))

manim_slides/slide/__init__.py

@@ -56,6 +56,8 @@ def __init__(self) -> None:
         raise ManimApiNotFoundError from e
 elif MANIMGL:
     try:
-        from .manimgl import Slide, ThreeDSlide
+        from .manimlib import Slide, ThreeDSlide
     except ImportError as e:
         raise ManimApiNotFoundError from e
+else:
+    raise ManimApiNotFoundError

manim_slides/slide/base.py

@@ -10,6 +10,7 @@
     Sequence,
     Tuple,
     ValuesView,
+    Protocol
 )
 
 import numpy as np
@@ -26,15 +27,17 @@
     Mobject = Any
 
 
-class Base(ABC):
-    _output_folder: Path = FOLDER_PATH
-    _slides: List[PreSlideConfig] = []
-    _current_slide = 1
-    _current_animation = 0
-    _loop_start_animation: Optional[int] = None
-    _pause_start_animation = 0
-    _canvas: MutableMapping[str, Mobject] = {}
-    _wait_time_between_slides = 0.0
+class BaseSlide:
+    def __init__(self, *args: Any, output_folder: Path = FOLDER_PATH, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+        self._output_folder: Path = output_folder
+        self._slides: List[PreSlideConfig] = []
+        self._current_slide = 1
+        self._current_animation = 0
+        self._loop_start_animation: Optional[int] = None
+        self._pause_start_animation = 0
+        self._canvas: MutableMapping[str, Mobject] = {}
+        self._wait_time_between_slides = 0.0
 
     @property
     def _ffmpeg_bin(self) -> Path:

manim_slides/slide/manim.py

@@ -3,10 +3,9 @@
 
 from manim import Scene, ThreeDScene, config
 
-from .base import Base
+from .base import BaseSlide
 
-
-class Slide(Base, Scene):  # type: ignore[misc]
+class Slide(BaseSlide, Scene):  # type: ignore[misc]
     """Inherits from :class:`Scene<manim.scene.scene.Scene>` and provide necessary tools
     for slides rendering."""
 
@@ -110,20 +109,16 @@ def construct(self):
                 bye = Text("Bye!")
 
                 self.start_loop()
-                self.play(
-                    self.wipe(
-                        self.mobjects_without_canvas,
-                        [bye],
-                        direction=UP
-                    )
+                self.wipe(
+                    self.mobjects_without_canvas,
+                    [bye],
+                    direction=UP
                 )
                 self.wait(.5)
-                self.play(
-                    self.wipe(
-                        self.mobjects_without_canvas,
-                        [title, sphere],
-                        direction=DOWN
-                    )
+                self.wipe(
+                    self.mobjects_without_canvas,
+                    [title, sphere],
+                    direction=DOWN
                 )
                 self.wait(.5)
                 self.end_loop()

manim_slides/slide/manimgl.py

@@ -4,10 +4,10 @@
 from manimlib import Scene, ThreeDCamera
 from manimlib.utils.file_ops import get_sorted_integer_files
 
-from .base import Base
+from .base import BaseSlide
 
 
-class Slide(Base, Scene):  # type: ignore[misc]
+class Slide(BaseSlide, Scene):  # type: ignore[misc]
     def __init__(self, *args: Any, **kwargs: Any) -> None:
         Path("videos").mkdir(exist_ok=True)
         kwargs["file_writer_config"].update(

tests/test_slide.py

@@ -11,6 +11,7 @@
 
 from manim_slides.config import PresentationConfig
 from manim_slides.slide.manim import Slide
+from manim_slides.defaults import FOLDER_PATH
 
 
 @click.command(
@@ -79,6 +80,17 @@ def test_render_basic_examples(
 
 
 class TestSlide:
+    @assert_construct
+    class TestDefaultProperties(Slide):
+        def construct(self) -> None:
+            assert self._output_folder == FOLDER_PATH
+            assert len(self._slides) == 0
+            assert self._current_slide == 1
+            assert self._loop_start_animation is None
+            assert self._pause_start_animation == 0
+            assert len(self._canvas) == 0
+            assert self._wait_time_between_slides == 0.0
+
     @assert_construct
     class TestLoop(Slide):
         def construct(self) -> None: