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_utils
  34    py_examples
  35
  36 Introduction
  37 ------------
  38
  39 This document provides a reference guide. For documentation on how to
  40 install aubio, see :ref:`python-install`.
  41
  42 Examples included in this guide and within the code are written assuming
  43 both `aubio` and `numpy`_ have been imported:
  44
  45 .. code-block:: python
  46
  47     >>> import aubio
  48     >>> import numpy as np
  49
  50 `Changed in 0.4.8` :  Prior to this version, almost no documentation was
  51 provided with the python module. This version adds documentation for some
  52 classes, including :class:`fvec`, :class:`cvec`, :class:`source`, and
  53 :class:`sink`.
  54
  55 .. _numpy: https://www.numpy.org