[python-dtcwt] 275/497: docs: make contents more priminant and useful in index

[Ghislain Vaillant]

This is an automated email from the git hooks/post-receive script.

ghisvail-guest pushed a commit to branch debian/sid
in repository python-dtcwt.

commit 36bbd2bd5542764b2a0bfc33dea09f9a11e9d1a0
Author: Rich Wareham <rjw57 at cam.ac.uk>
Date:   Thu Jan 30 13:57:16 2014 +0000

    docs: make contents more priminant and useful in index
---
 docs/index.rst | 37 ++++++++++++-------------------------
 1 file changed, 12 insertions(+), 25 deletions(-)

diff --git a/docs/index.rst b/docs/index.rst
index 71c5d1e..d94e62c 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -2,20 +2,21 @@ The dtcwt library
 =================
 
 This library provides support for computing 1D, 2D and 3D dual-tree complex
-wavelet transforms and their inverse in Python. The interface is simple and
-easy to use. As a quick example, a 1D DT-CWT can be performed from the Python
-console in a single line::
+wavelet transforms and their inverse in Python along with some signal
+processing algorithms which make use of the DTCWT.
 
-    >>> import dtcwt
-    >>> Yl, Yh = dtcwt.dtwavexfm([1,2,3,4], nlevels=3) # 3 levels, default wavelets
+Contents
+````````
 
-The interface is intentionally similar to the existing MATLAB dual-tree complex
-wavelet transform toolbox provided by `Prof. Nick Kingsbury
-<http://www-sigproc.eng.cam.ac.uk/~ngk/>`_. This library is intended to ease
-the porting of algorithms written using the original MATLAB toolbox to Python.
+.. toctree::
+    :maxdepth: 2
 
-The library also includes an OpenCL-based implementation of the wavelet
-transform which can accelerate computation even on CPU-only devices.
+    gettingstarted
+    variant
+    backends
+    registration
+    examples
+    reference
 
 Features of note
 ````````````````
@@ -28,20 +29,6 @@ The features of the ``dtcwt`` library are:
 * Automatic selection of single versus double precision calculation.
 * Built-in support for the most common complex wavelet families.
 
-Contents
-````````
-
-.. toctree::
-    :maxdepth: 1
-
-    gettingstarted
-    variant
-    backends
-    registration
-    examples
-    reference
-
-
 Licence
 ```````
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/python-dtcwt.git