source: doc/python.rst @ a59ecb7

feature/cnnfeature/crepefix/ffmpeg5
Last change on this file since a59ecb7 was 67b2409a, checked in by Paul Brossier <piem@piem.org>, 6 years ago

[doc] add py_synth page

  • Property mode set to 100644
File size: 1.2 KB
RevLine 
[152bf4f]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
[f8bf0c2]10..
11   note: we do not import aubio's docstring, which will be displayed from an
12   interpreter.
13
14.. .. automodule:: aubio
15
[152bf4f]16
[68daf5b]17.. _python:
18
[152bf4f]19Python documentation
20====================
21
[f8bf0c2]22This module provides a number of classes and functions for the analysis of
23music and audio signals.
24
25Contents
26--------
27
28.. toctree::
29   :maxdepth: 1
30
31   py_datatypes
32   py_io
[134f1b7]33   py_temporal
[d958b3c]34   py_spectral
[12f7bfe]35   py_analysis
[67b2409a]36   py_synth
[f8bf0c2]37   py_utils
[dc3f68d]38   py_examples
[152bf4f]39
[f8bf0c2]40Introduction
41------------
[152bf4f]42
[f8bf0c2]43This document provides a reference guide. For documentation on how to
44install aubio, see :ref:`python-install`.
[152bf4f]45
[f8bf0c2]46Examples included in this guide and within the code are written assuming
47both `aubio` and `numpy`_ have been imported:
[152bf4f]48
[f8bf0c2]49.. code-block:: python
[152bf4f]50
[f8bf0c2]51    >>> import aubio
52    >>> import numpy as np
[152bf4f]53
[f8bf0c2]54`Changed in 0.4.8` :  Prior to this version, almost no documentation was
55provided with the python module. This version adds documentation for some
56classes, including :class:`fvec`, :class:`cvec`, :class:`source`, and
57:class:`sink`.
[152bf4f]58
[f8bf0c2]59.. _numpy: https://www.numpy.org
Note: See TracBrowser for help on using the repository browser.