doc/*.rst: use console highlighting

[aubio.git] / doc / python_module.rst

diff --git a/doc/python_module.rst b/doc/python_module.rst
index 3568ba8..f801368 100644 (file)
--- a/doc/python_module.rst
+++ b/doc/python_module.rst
@@ -1,10 +1,16 @@
+.. _python:
+
 Python module
 =============
 
+The aubio extension for Python is available for Python 2.7 and Python 3.
+
 Installing aubio with pip
 -------------------------
 
-.. code-block:: bash
+aubio can now be installed using ``pip``:
+
+.. code-block:: console
 
     $ pip install aubio
 
@@ -13,7 +19,7 @@ Building the module
 
 From ``aubio`` source directory, run the following:
 
-.. code-block:: bash
+.. code-block:: console
 
     $ ./setup.py clean
     $ ./setup.py build
@@ -22,34 +28,37 @@ From ``aubio`` source directory, run the following:
 Using aubio in python
 ---------------------
 
-Once you have python-aubio installed, you should be able to run ``python -c
-"import aubio"``.
+Once the python module is installed, its version can be checked with:
+
+.. code-block:: console
 
-A very simple example
-.....................
+    $ python -c "import aubio; print(aubio.version, aubio.float_type)"
 
-Here is a very simple script
-to read all the samples from a media file:
+The command line `aubio` is also installed:
 
-.. code-block:: python
+.. code-block:: console
 
-        #! /usr/bin/env python
-        import aubio
+    $ aubio -h
 
-        s = aubio.source(sys.argv[1], 0, 256)
-        while True:
-          samples, read = s()
-          #print(samples)
-          if read < 256: break
+A simple example
+................
+
+Here is a :download:`simple script <../python/demos/demo_source_simple.py>`
+that reads all the samples from a media file:
+
+.. literalinclude:: ../python/demos/demo_source_simple.py
+   :language: python
 
 Filtering an input sound file
 .............................
 
-Here is a more complete example, `demo_filter.py`_. This files executes the following:
+Here is a more complete example, :download:`demo_filter.py
+<../python/demos/demo_filter.py>`. This files executes the following:
 
 * read an input media file (``aubio.source``)
 
-* filter it using an A-weighting filter (``aubio.digital_filter``)
+* filter it using an `A-weighting <https://en.wikipedia.org/wiki/A-weighting>`_
+  filter (``aubio.digital_filter``)
 
 * write result to a new file (``aubio.sink``)
 
@@ -67,7 +76,7 @@ Python tests
 A number of `python tests`_ are provided. To run them, use
 ``python/tests/run_all_tests``.
 
-.. _python tests folder: https://github.com/aubio/aubio/blob/master/python/tests
 .. _python demos folder: https://github.com/aubio/aubio/blob/master/python/demos
 .. _demo_filter.py: https://github.com/aubio/aubio/blob/master/python/demos/demo_filter.py
+.. _python tests: https://github.com/aubio/aubio/blob/master/python/tests