From cc9690b7556d11ab5139b0869f237d7721154abb Mon Sep 17 00:00:00 2001 From: Thomas Fillon Date: Mon, 12 Jan 2015 15:25:35 +0100 Subject: [PATCH] Doc: Update documentation (fix path) --- doc/source/api/decoder/index.rst | 8 ++++---- doc/source/tutorial/frames_stack.rst | 14 +++++++------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/doc/source/api/decoder/index.rst b/doc/source/api/decoder/index.rst index 8283527..5813713 100644 --- a/doc/source/api/decoder/index.rst +++ b/doc/source/api/decoder/index.rst @@ -6,13 +6,13 @@ Decoder package .. toctree:: :maxdepth: 2 -.. automodule:: timeside.decoder +.. automodule:: timeside.plugins.decoder File Decoder ============ -.. autoclass:: timeside.decoder.file.FileDecoder +.. autoclass:: timeside.plugins.decoder.file.FileDecoder :members: :undoc-members: :show-inheritance: @@ -20,7 +20,7 @@ File Decoder Array Decoder ============= -.. autoclass:: timeside.decoder.array.ArrayDecoder +.. autoclass:: timeside.plugins.decoder.array.ArrayDecoder :members: :undoc-members: :show-inheritance: @@ -28,7 +28,7 @@ Array Decoder Live Decoder ============ -.. autoclass:: timeside.decoder.live.LiveDecoder +.. autoclass:: timeside.plugins.decoder.live.LiveDecoder :members: :undoc-members: :show-inheritance: diff --git a/doc/source/tutorial/frames_stack.rst b/doc/source/tutorial/frames_stack.rst index c8272eb..39075ae 100644 --- a/doc/source/tutorial/frames_stack.rst +++ b/doc/source/tutorial/frames_stack.rst @@ -5,26 +5,26 @@ Running a pipe with previously decoded frames =============================================== -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. +Example of use of the `stack` argument in :class:`timeside.plugins.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 : ->>> import timeside +>>> import timeside.core >>> from timeside.core import get_processor >>> from timeside.tools.test_samples import samples >>> import numpy as np >>> audio_file = 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.file.FileDecoder(audio_file, stack=True) +>>> decoder = timeside.plugins.decoder.file.FileDecoder(audio_file, stack=True) Setup an arbitrary analyzer to check that decoding process from file and from stack are equivalent: ->>> pitch = get_processor('aubio_pitch')() ->>> pipe = (decoder | pitch) +>>> level = get_processor('level')() +>>> pipe = (decoder | level) >>> print pipe.processors #doctest: +ELLIPSIS -[file_decoder-{}, aubio_pitch-{"blocksize_s": 0.0, "stepsize_s": 0.0}] +[file_decoder-{}, level-{}] Run the pipe: -- 2.39.5