ref: 7cfad8e10b28f1e37c02a0cf8a10e95e96e86488
parent: 78c1d32f5400a9de0524dd5bd1c9405ecf65166f
author: Paul Brossier <piem@piem.org>
date: Tue Oct 30 15:04:11 EDT 2018
[py] add basic module docstring
--- a/python/lib/aubio/__init__.py
+++ b/python/lib/aubio/__init__.py
@@ -1,4 +1,26 @@
#! /usr/bin/env python
+# -*- coding: utf8 -*-
+
+"""
+aubio
+=====
+
+Provides a number of classes and functions for music and audio signal
+analysis.
+
+How to use the documentation
+----------------------------
+
+Documentation of the python module is available as docstrings provided
+within the code, and a reference guide available online from `the
+aubio homepage <https://aubio.org/documentation>`_.
+
+The docstrings examples are written assuming `aubio` and `numpy` have been
+imported with:
+
+>>> import aubio
+>>> import numpy as np
+"""
import numpy
from ._aubio import __version__ as version