Commit 316aefd9 authored by André Anjos's avatar André Anjos

Fix documentation

parent 42e988b7
Pipeline #4750 failed with stages
in 8 minutes and 10 seconds
......@@ -131,7 +131,7 @@ pygments_style = 'sphinx'
# Some variables which are useful for generated material
project_variable = project.replace('.', '_')
short_description = u'Bob's audio processing utilities'
short_description = u'Bob\'s audio processing utilities'
owner = [u'Idiap Research Institute']
......
......@@ -50,9 +50,10 @@ Other features can be computed in a similar fashion (please check Python API for
Reading audio files
~~~~~~~~~~~~~~~~~~~
The usual native formats can be read with :py:mod:`scipy.io.wavfile` module. Other
wave formats can be found in some other python modules like :py:mod:`pysox`. An
example of wave file can be found here ``bob/ap/test/data/sample.wav``
The usual native formats can be read with :py:mod:`scipy.io.wavfile` module.
These and other wave formats can be read through SoX_ using our native
bindings at :py:mod:`bob.io.audio`. An example of wave file can be found at
``bob/ap/test/data/sample.wav``.
.. doctest:: aptest
:options: +NORMALIZE_WHITESPACE
......@@ -147,3 +148,4 @@ It is also possible to compute first and second derivatives for those features:
>>> print(len(lfcc_e_d_dd[0]))
60
.. include:: links.rst
......@@ -78,3 +78,4 @@
.. _libpng license: http://www.libpng.org/pub/png/src/libpng-LICENSE.txt
.. _mit: http://www.opensource.org/licenses/MIT
.. _python-2.0: http://www.opensource.org/licenses/Python-2.0
.. _sox: http://sox.sourceforge.net/
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment