[python-dtcwt] 99/497: freshen up the docs a little

[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 ae886463d8fef8ac8ec3c82a6336265b7c19233c
Author: Rich Wareham <rjw57 at cam.ac.uk>
Date:   Fri Aug 9 17:16:28 2013 +0100

    freshen up the docs a little
    
    Add a little more meat to the introduction for the library.
---
 docs/gettingstarted.rst | 27 ++----------------
 docs/index.rst          | 76 ++++++++++++++++++++++++++++++++++++++++---------
 docs/reference.rst      |  7 +++--
 3 files changed, 70 insertions(+), 40 deletions(-)

diff --git a/docs/gettingstarted.rst b/docs/gettingstarted.rst
index fbf8ce7..693c73c 100644
--- a/docs/gettingstarted.rst
+++ b/docs/gettingstarted.rst
@@ -1,31 +1,8 @@
 Getting Started
 ===============
 
-This section will guide you through installing and using the ``dtcwt`` library.
-
-Installation
-````````````
-
-Installation is based on setuptools and follows the usual conventions for a
-Python project
-
-.. code-block:: console
-
-    $ python setup.py install
-
-A minimal test suite is provided so that you may verify the code works on your
-system
-
-.. code-block:: console
-
-    $ python setup.py nosetests
-
-This will also write test-coverage information to the ``cover/`` directory.
-
-Simple usage
-````````````
-
-Once installed, you are most likely to use one of these functions:
+This section will guide you through using the ``dtcwt`` library.  Once
+installed, you are most likely to use one of these functions:
 
 * :py:func:`dtcwt.dtwavexfm` -- 1D DT-CWT transform.
 * :py:func:`dtcwt.dtwaveifm` -- Inverse 1D DT-CWT transform.
diff --git a/docs/index.rst b/docs/index.rst
index a36b0c7..d731bbb 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,38 +1,88 @@
 The dtcwt library
 =================
 
-This library provides support for computing 1D, 2D and 3D dual-tree complex wavelet
-transforms and their inverse in Python.
+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::
+
+    >>> import dtcwt
+    >>> Yl, Yh = dtcwt.dtwavexfm([1,2,3,4], nlevels=3) # 3 levels, default wavelets
 
 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 this toolbox from MATLAB to Python.
+the porting of algorithms written using the original MATLAB toolbox to Python.
+
+Features of note
+````````````````
+
+The features of the ``dtcwt`` library are:
+
+* 1D, 2D and 3D forward and inverse Dual-tree Complex Wavelet Transform
+  implementations.
+* API similarity with the DTCW MATLAB toolbox.
+* Automatic selection of single versus double precision calculation.
+* Built-in support for the most common complex wavelet families.
+
+Installation
+````````````
+
+The easiest way to install ``dtcwt`` is via ``easy_install`` or ``pip``:
+
+.. code-block:: console
+
+    $ pip install dtcwt
+
+If you want to check out the latest in-development version, look at
+`the project's GitHub page <https://github.com/rjw57/dtcwt>`_. Once checked out,
+installation is based on setuptools and follows the usual conventions for a
+Python project:
+
+.. code-block:: console
+
+    $ python setup.py install
+
+(Although the `develop` command may be more useful if you intend to perform any
+significant modification to the library.) A test suite is provided so that you
+may verify the code works on your system:
+
+.. code-block:: console
+
+    $ python setup.py nosetests
+
+This will also write test-coverage information to the ``cover/`` directory.
+
+Further documentation
+`````````````````````
+
+There is `more documentation <https://dtcwt.readthedocs.org/>`_
+available online and you can build your own copy via the Sphinx documentation
+system::
+
+    $ python setup.py build_sphinx
+
+Compiled documentation may be found in ``build/docs/html/``.
+
+Licence
+```````
 
 The original toolbox is copyrighted and there are some restrictions on use
 which are outlined in the file
 :download:`ORIGINAL_README.txt<../ORIGINAL_README.txt>`.
-
 Aside from portions directly derived from the original MATLAB toolbox, any
 additions in this library and this documentation are licensed under the
 2-clause BSD licence as documented in the file
 :download:`COPYING.txt<../COPYING.txt>`.
 
-Table of Contents
+Contents
 `````````````````
 
 .. toctree::
-    :maxdepth: 2
+    :maxdepth: 1
 
     gettingstarted
     examples
     reference
 
-Indices and tables
-``````````````````
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-
 .. vim:sw=4:sts=4:et
diff --git a/docs/reference.rst b/docs/reference.rst
index 827d32c..c65c8f6 100644
--- a/docs/reference.rst
+++ b/docs/reference.rst
@@ -1,5 +1,8 @@
-Reference
-=========
+API Reference
+=============
+
+Computing the DT-CWT
+````````````````````
 
 .. automodule:: dtcwt
     :members:

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