.. mdinclude:: ../index_readme.md
    :start-line: 0

API documentation
=================

Documentation of the API of *PyGenStability*. 

.. toctree::
   :maxdepth: 2

   pygenstability
   constructors
   app
   plotting
   dataclustering
   optimal_scales
   io
   examples/example