.. matnimation documentation master file, created by
   sphinx-quickstart on Mon Apr 22 12:27:37 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to matnimation's API documentation!
=======================================
This is the API documentation for ``matnimation``, a wrapper around Matplotlib to easily build animations. For tutorials and examples on what ``matnimation`` can do, check out the corresponding `GitHub repository <https://github.com/timdewild/matnimation>`_. 


.. toctree::
   :maxdepth: 2
   :caption: API Documentation:

   src.matnimation.animation
   src.matnimation.artist
   src.matnimation.artist.static
   src.matnimation.artist.animated
   src.matnimation.canvas

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`