From 3f023208986b18d2fdabd2518ca0e4d0b9c1229f Mon Sep 17 00:00:00 2001 From: Guillaume Pellerin Date: Thu, 29 Jan 2015 13:08:11 +0100 Subject: [PATCH] fix doc --- README.rst | 8 +------- doc/source/intro.rst | 7 ------- doc/source/news.rst | 2 +- 3 files changed, 2 insertions(+), 15 deletions(-) diff --git a/README.rst b/README.rst index 92b944a..a8fc4ab 100644 --- a/README.rst +++ b/README.rst @@ -61,15 +61,9 @@ Dive in To list all available plugins:: - import os - os.remove('sweep.ogg') - os.remove('waveform.png') - - >>> import timeside.core >>> timeside.core.list_processors() - Define some processors:: @@ -114,7 +108,7 @@ News * Code refactoring: - Create a new module `timeside.plugins` and move processors therein: timeside.plugins.decoder,analyzer, timeside.plugins.encoder, timeside.plugins.fx - - WARNING: to properly manage the namespace packages structure, the TimeSide main module is now `timeside.core` and code should now be initialized with `import timeside.core`. + - WARNING: to properly manage the namespace packages structure, the TimeSide main module is now `timeside.core` and code should now be initialized with `import timeside.core` - `timeside.plugins` is now a `namespace package `_ enabling external plugins to be **automatically** plugged into TimeSide (see for example `timeside-diadems `_). This now makes TimeSide a **real** plugin host, yeah! - A dummy timeside plugin will soon be provided for easy development start. diff --git a/doc/source/intro.rst b/doc/source/intro.rst index 6e9393c..0417bc2 100644 --- a/doc/source/intro.rst +++ b/doc/source/intro.rst @@ -60,18 +60,11 @@ Dive in To list all available plugins:: -.. testcleanup:: - - import os - os.remove('sweep.ogg') - os.remove('waveform.png') - .. doctest:: >>> import timeside.core >>> timeside.core.list_processors() - Define some processors:: .. doctest:: diff --git a/doc/source/news.rst b/doc/source/news.rst index 583e38b..d1da3a4 100644 --- a/doc/source/news.rst +++ b/doc/source/news.rst @@ -10,7 +10,7 @@ News * Code refactoring: - Create a new module `timeside.plugins` and move processors therein: timeside.plugins.decoder,analyzer, timeside.plugins.encoder, timeside.plugins.fx - - WARNING: to properly manage the namespace packages structure, the TimeSide main module is now `timeside.core` and code should now be initialized with `import timeside.core`. + - WARNING: to properly manage the namespace packages structure, the TimeSide main module is now `timeside.core` and code should now be initialized with `import timeside.core` - `timeside.plugins` is now a `namespace package `_ enabling external plugins to be **automatically** plugged into TimeSide (see for example `timeside-diadems `_). This now makes TimeSide a **real** plugin host, yeah! - A dummy timeside plugin will soon be provided for easy development start. -- 2.39.5