refactor(lib): change how manim API is imported (#285)

* refactor(lib): change how manim API is imported

* chore(lib): delete old files

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* wip: moving all commands

* adding animations

* fix tests

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix mypy

* fixes

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* trying to fix docs

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* wip: docs

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* make it work

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* wip test

* tests are working

* improving docs

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix index

* docs: nicer shift

* docs: nicer quickstart example

* fix tests

* change tests

* move coverage to test workflow

* fix(tests): remove resolve

* strict resolve

* change local path test

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* documented changes

* cleanup docs

* cleanup files

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix(ci): set type

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

docs/source/conf.py

@@ -29,9 +29,7 @@ extensions = [
     "manim_slides.docs.manim_slides_directive",
 ]
 
-typehints_defaults = "comma"
-typehints_use_signature = True
-typehints_use_signature_return = True
+autodoc_typehints = "both"
 
 myst_enable_extensions = [
     "colon_fence",
@@ -41,6 +39,8 @@ myst_enable_extensions = [
 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
@@ -74,6 +74,7 @@ intersphinx_mapping = {
     "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/docutils.conf

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

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`.

docs/source/reference/api.md

@@ -6,8 +6,10 @@ 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,
@@ -15,13 +17,25 @@ use, not the methods used internally when rendering.
         end_loop,
         mobjects_without_canvas,
         next_slide,
-        pause,
         remove_from_canvas,
         start_loop,
         wait_time_between_slides,
         wipe,
         zoom,
+```
 
-.. autoclass:: manim_slides.ThreeDSlide
+## 3D Slide
+
+```{eval-rst}
+.. autoclass:: manim_slides.slide.ThreeDSlide
     :members:
 ```
+
+## Animations
+
+```{eval-rst}
+.. automodule:: manim_slides.slide.animation
+    :members:
+        Wipe,
+        Zoom,
+```