cleanup docs

docs/source/conf.py

@@ -23,21 +23,13 @@
     "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
+autodoc_typehints = "both"
 
 myst_enable_extensions = [
     "colon_fence",
@@ -82,6 +74,7 @@
     "python": ("https://docs.python.org/3", None),
     "manim": ("https://docs.manim.community/en/stable/", None),
     "manimlib": ("https://3b1b.github.io/manim/", None),
+    "numpy": ("https://numpy.org/doc/stable/", None),
 }
 
 # -- OpenGraph settings

docs/source/features_table.md

@@ -13,7 +13,6 @@ The following summarizes the different presentation features Manim Slides offers
 | Pause animation | Yes | No | No | N/A |
 | Play slide in reverse | Yes | No | No | N/A |
 | Slide count | Yes | Yes (optional) | Yes (optional) | N/A |
-| Animation count | Yes | No | No | N/A |
 | Needs Python with Manim Slides installed | Yes | No | No | No
 | Requires internet access | No | Yes | No | No |
 | Auto. play slides | Yes | Yes | Yes | N/A |
@@ -23,5 +22,8 @@ The following summarizes the different presentation features Manim Slides offers
 | Works cross-platforms | Yes | Yes | Partly[^1][^2] | Yes |
 :::
 
-[^1]: If you encounter a problem where slides do not automatically play or loops do not work, please [file an issue on GitHub](https://github.com/jeertmans/manim-slides/issues/new/choose).
-[^2]: PowerPoint online does not seem to support automatic playing of videos, so you need LibreOffice Impress on Linux platforms.
+[^1]: If you encounter a problem where slides do not automatically play or loops do not work,
+  please
+  [file an issue on GitHub](https://github.com/jeertmans/manim-slides/issues/new/choose).
+[^2]: PowerPoint online does not seem to support automatic playing of videos,
+  so you need LibreOffice Impress on Linux platforms.

docs/source/index.md

@@ -42,6 +42,7 @@ Manim Slides.
 quickstart
 reference/index
 features_table
+manim_or_manimgl
 ```
 
 ```{toctree}

docs/source/manim_or_manimgl.md

@@ -0,0 +1,71 @@
+# Manim or ManimGL
+
+Manim Slides supports both Manim (Community Edition) and ManimGL (by 3b1b).
+
+Because both modules have slightly different APIs, Manim Slides needs to know
+which Manim API you are using, to import the correct module.
+
+## Default Behavior
+
+By default, Manim Slides looks at {py:data}`sys.modules` and chooses the first
+Manim package that is already imported: `manim` for Manim,
+`manimlib` for ManimGL. This works pretty well when rendering
+the slides.
+
+If both modules are present in {py:data}`sys.modules`, then Manim Slides will
+prefer using `manim`.
+
+
+### Usage
+
+The simplest way to use Manim Slides with the correct Manim API is to:
+
+1. first import the Manim API;
+2. and, then, import `manim_slides`.
+
+Example for `manim`:
+
+```python
+from manim import *
+from manim_slides import Slide
+```
+
+Example for `manimlib`:
+
+```python
+from manimlib import *
+from manim_slides import Slide
+```
+
+### Example of Default Import
+
+The following code shows how Manim Slides detected that `manimlib`
+was imported, so the {py:class}`Slide<manim_slides.slide.Slide>`
+automatically subclasses the class from ManimGL, not Manim.
+
+```python
+from manimlib import Scene
+from manim_slides import Slide
+
+assert issubclass(Slide, Scene) # Slide subclasses Scene from ManimGL
+
+from manim import Scene
+
+assert not issubclass(Slide, Scene) # but not Scene from Manim
+```
+
+## Custom Manim API
+
+If you want to override the default Manim API, you can set the `MANIM_API`
+environment variable to:
+
+- `manim` or `manimce` to import `manim`;
+- `manimlib` or `manimgl` to import `manimlib`;
+
+prior to importing `manim_slides`.
+
+Note that Manim Slides will still first look at {py:data}`sys.modules` to check
+if any of the two modules is already imported.
+
+If you want to force Manim Slides to obey the `MANIM_API` environment variable,
+you must also set `FORCE_MANIM_API=1`.

manim_slides/slide/animation.py

@@ -5,20 +5,24 @@
 :meth:`Scene.play<manim.scene.scene.Scene.play>` call.
 
 For each of the provided classes, there exists a method variant
-that directly calls :python:`self.play(Animation(...))`, see
-:class:`Slide`.
+that directly calls ``self.play(Animation(...))``, see
+:class:`Slide<manim_slides.slide.Slide>`.
 """
 
+__all__ = ["Wipe", "Zoom"]
+
 from typing import Any, Mapping, Sequence
 
 import numpy as np
 
 from . import MANIM
 
 if MANIM:
-    from manim import LEFT, AnimationGroup, FadeIn, FadeOut, Mobject
+    from manim import LEFT, AnimationGroup, FadeIn, FadeOut
+    from manim.mobject.mobject import Mobject
 else:
-    from manimlib import LEFT, AnimationGroup, FadeIn, FadeOut, Mobject
+    from manimlib import LEFT, AnimationGroup, FadeIn, FadeOut
+    Mobject = Any
 
 
 class Wipe(AnimationGroup):  # type: ignore[misc]

manim_slides/slide/base.py

@@ -1,8 +1,9 @@
+__all__ = ["BaseSlide"]
+
 import platform
 from abc import abstractmethod
 from pathlib import Path
 from typing import (
-    TYPE_CHECKING,
     Any,
     List,
     MutableMapping,
@@ -20,12 +21,13 @@
 from ..logger import logger
 from ..utils import concatenate_video_files, merge_basenames, reverse_video_file
 
-if TYPE_CHECKING:
-    from manim import Mobject
+from . import MANIM
+
+if MANIM:
+    from manim.mobject.mobject import Mobject
 else:
     Mobject = Any
 
-
 class BaseSlide:
     def __init__(
         self, *args: Any, output_folder: Path = FOLDER_PATH, **kwargs: Any