.. flashplot documentation master file, created by
   sphinx-quickstart on Tue Sep  2 22:21:23 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

flashplot documentation
=======================

.. automodule:: flashplot

.. toctree::
   :maxdepth: 2
   :caption: Contents:

Usage
--------

Here's a short example script going over basic usage:

.. literalinclude:: ../../examples/examples.py
        :language: python
        :linenos:

`View examples/examples.py on GitHub <https://github.com/jsnguyen/flashplot/blob/main/examples/examples.py>`_

API Reference
-------------

.. autofunction:: flashplot.imshow
.. autofunction:: flashplot.plot
.. autofunction:: flashplot.make_mp4_from_data
.. autofunction:: flashplot.make_mp4_from_files
.. autofunction:: flashplot.show_mp4