1 .. make sure our default-domain is python here
5 .. currentmodule:: aubio
8 we follow numpy type docstrings, see:
9 https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard
11 note: we do not import aubio's docstring, which will be displayed from an
14 .. .. automodule:: aubio
22 This module provides a number of classes and functions for the analysis of
23 music and audio signals.
41 This document provides a reference guide. For documentation on how to
42 install aubio, see :ref:`python-install`.
44 Examples included in this guide and within the code are written assuming
45 both `aubio` and `numpy`_ have been imported:
47 .. code-block:: python
50 >>> import numpy as np
52 `Changed in 0.4.8` : Prior to this version, almost no documentation was
53 provided with the python module. This version adds documentation for some
54 classes, including :class:`fvec`, :class:`cvec`, :class:`source`, and
57 .. _numpy: https://www.numpy.org