doc/python.rst

   1 .. make sure our default-domain is python here
   2 .. default-domain:: py
   3
   4 .. set current module
   5 .. currentmodule:: aubio
   6
   7 ..
   8    we follow numpy type docstrings, see:
   9    https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard
  10 ..
  11    note: we do not import aubio's docstring, which will be displayed from an
  12    interpreter.
  13
  14 .. .. automodule:: aubio
  15
  16
  17 .. _python:
  18
  19 Python documentation
  20 ====================
  21
  22 This module provides a number of classes and functions for the analysis of
  23 music and audio signals.
  24
  25 Contents
  26 --------
  27
  28 .. toctree::
  29    :maxdepth: 1
  30
  31    py_datatypes
  32    py_io
  33    py_temporal
  34    py_spectral
  35    py_utils
  36    py_examples
  37
  38 Introduction
  39 ------------
  40
  41 This document provides a reference guide. For documentation on how to
  42 install aubio, see :ref:`python-install`.
  43
  44 Examples included in this guide and within the code are written assuming
  45 both `aubio` and `numpy`_ have been imported:
  46
  47 .. code-block:: python
  48
  49     >>> import aubio
  50     >>> import numpy as np
  51
  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
  55 :class:`sink`.
  56
  57 .. _numpy: https://www.numpy.org