From: Paul Brossier <piem@piem.org>
Date: Tue, 30 Oct 2018 18:04:11 +0000 (+0100)
Subject: [py] add basic module docstring
X-Git-Tag: 0.4.8~90^2~10
X-Git-Url: https://git.aubio.org/?a=commitdiff_plain;h=7cfad8e10b28f1e37c02a0cf8a10e95e96e86488;p=aubio.git

[py] add basic module docstring
---

diff --git a/python/lib/aubio/__init__.py b/python/lib/aubio/__init__.py
index 9c202c78..87a357da 100644
--- 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