From: Guillaume Pellerin Date: Wed, 8 Jan 2014 16:53:47 +0000 (+0100) Subject: fix doctest decoder module import X-Git-Tag: 0.5.3~28 X-Git-Url: https://git.parisson.com/?a=commitdiff_plain;h=82a87365548f0724e2817a6e43c81f7f673f40a1;p=timeside.git fix doctest decoder module import --- diff --git a/doc/source/api/decoder/index.rst b/doc/source/api/decoder/index.rst index 5f06ac1..34b6df6 100644 --- a/doc/source/api/decoder/index.rst +++ b/doc/source/api/decoder/index.rst @@ -6,7 +6,7 @@ Decoder package .. toctree:: :maxdepth: 2 -.. automodule:: timeside.decoder.core +.. automodule:: timeside.decoder File Decoder diff --git a/doc/source/tutorial/frames_stack.rst b/doc/source/tutorial/frames_stack.rst index e7207e9..6cab3c2 100644 --- a/doc/source/tutorial/frames_stack.rst +++ b/doc/source/tutorial/frames_stack.rst @@ -5,7 +5,7 @@ Running a pipe with previously decoded frames =============================================== -Example of use of the `stack` argument in :class:`timeside.decoder.core.FileDecoder` to run a pipe with previously decoded frames stacked in memory on a second pass. +Example of use of the `stack` argument in :class:`timeside.decoder.file.FileDecoder` to run a pipe with previously decoded frames stacked in memory on a second pass. First, let's import everything and define the audio file source : @@ -13,7 +13,7 @@ First, let's import everything and define the audio file source : >>> import numpy as np >>> audio_file = 'http://github.com/yomguy/timeside-samples/raw/master/samples/sweep.mp3' -Then let's setup a :class:`FileDecoder ` with argument `stack=True` (default argument is `stack=False`) : +Then let's setup a :class:`FileDecoder ` with argument `stack=True` (default argument is `stack=False`) : >>> decoder = timeside.decoder.FileDecoder(audio_file, stack=True) @@ -22,13 +22,13 @@ Setup an arbitrary analyzer to check that decoding process from file and from st >>> pitch_on_file = timeside.analyzer.AubioPitch() >>> pipe = (decoder | pitch_on_file) >>> print pipe.processors #doctest: +ELLIPSIS -[, ] +[, ] -After the pipe has been run, the other processes of the pipe are removed from the pipe and only the :class:`FileDecoder ` is kept : +After the pipe has been run, the other processes of the pipe are removed from the pipe and only the :class:`FileDecoder ` is kept : >>> pipe.run() >>> print pipe.processors #doctest: +ELLIPSIS -[] +[] The processed frames are stored in the pipe attribute `frames_stack` as a list of frames : @@ -54,7 +54,7 @@ Add it to the pipe: >>> pipe |= pitch_on_stack >>> print pipe.processors #doctest: +ELLIPSIS -[, ] +[, ] And run the pipe: