opensource/manim-slides
1
0
Fork 0
mirror of https://github.com/jeertmans/manim-slides.git synced 2025-05-21 04:26:40 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
manim-slides/docs/source/reference/api.md
Jérome Eertmans 540c7034c8 feat(lib/docs): add sphinx directive (#216) 
This PR adds a new Sphinx directive, inspired by the Manim one. This directive is also used within the docs to display examples.
2023-07-19 17:11:58 +02:00

495 B
Raw Blame History

Application Programming Interface

Manim Slides' API is very limited: it simply consists of two classes, Slide 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.

.. autoclass:: manim_slides.Slide
    :members: start_loop, end_loop, pause, next_slide, wipe

.. autoclass:: manim_slides.ThreeDSlide
    :members: