source:
doc/python.rst
@
f19db54
Last change on this file since f19db54 was dc3f68d, checked in by , 6 years ago | |
---|---|
|
|
File size: 1.2 KB |
Rev | Line | |
---|---|---|
[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] | 19 | Python documentation |
20 | ==================== | |
21 | ||
[f8bf0c2] | 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 | |
[dc3f68d] | 34 | py_examples |
[152bf4f] | 35 | |
[f8bf0c2] | 36 | Introduction |
37 | ------------ | |
[152bf4f] | 38 | |
[f8bf0c2] | 39 | This document provides a reference guide. For documentation on how to |
40 | install aubio, see :ref:`python-install`. | |
[152bf4f] | 41 | |
[f8bf0c2] | 42 | Examples included in this guide and within the code are written assuming |
43 | both `aubio` and `numpy`_ have been imported: | |
[152bf4f] | 44 | |
[f8bf0c2] | 45 | .. code-block:: python |
[152bf4f] | 46 | |
[f8bf0c2] | 47 | >>> import aubio |
48 | >>> import numpy as np | |
[152bf4f] | 49 | |
[f8bf0c2] | 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`. | |
[152bf4f] | 54 | |
[f8bf0c2] | 55 | .. _numpy: https://www.numpy.org |
Note: See TracBrowser
for help on using the repository browser.