.. PartielsPy documentation master file, created by
   sphinx-quickstart on Fri May 16 15:09:33 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to PartielsPy's documentation!
--------------------------------------
PartielsPy is a python wrapper for the audio analysis program `Partiels <https://github.com/Ircam-Partiels/Partiels>`_ 
developed by Pierre Guillot.
Please visit the `Github Page <https://github.com/Ircam-Partiels/PartielsPy>`_ of the project for more information.
Some practical examples are available `here <https://github.com/Ircam-Partiels/PartielsPy/tree/main/examples>`_.


.. toctree::
   :maxdepth: 2
   :caption: API Reference:

   modules