[python-dtcwt] 360/497: remove unnecessary bits of the docs
Ghislain Vaillant
ghisvail-guest at moszumanska.debian.org
Tue Jul 21 18:06:28 UTC 2015
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 c284064776b0e660ea622c560a00d15d76bac256
Author: Rich Wareham <rjw57 at cam.ac.uk>
Date: Fri Feb 7 14:53:22 2014 +0000
remove unnecessary bits of the docs
The LICENCE and Features of note sections were a little superfluous. The
overview of MATLAB compatible functions was just wrong.
---
docs/gettingstarted.rst | 14 ++------------
docs/index.rst | 22 ----------------------
2 files changed, 2 insertions(+), 34 deletions(-)
diff --git a/docs/gettingstarted.rst b/docs/gettingstarted.rst
index b7fc057..298aeaa 100644
--- a/docs/gettingstarted.rst
+++ b/docs/gettingstarted.rst
@@ -1,18 +1,8 @@
Getting Started
===============
-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.
-* :py:func:`dtcwt.dtwavexfm2` -- 2D DT-CWT transform.
-* :py:func:`dtcwt.dtwaveifm2` -- Inverse 2D DT-CWT transform.
-* :py:func:`dtcwt.dtwavexfm3` -- 3D DT-CWT transform.
-* :py:func:`dtcwt.dtwaveifm3` -- Inverse 3D DT-CWT transform.
-
-See :doc:`reference` for full details on how to call these functions. We shall
-present some simple usage below.
+This section will guide you through using the ``dtcwt`` library. See
+:doc:`reference` for full details on the library's API.
Installation
------------
diff --git a/docs/index.rst b/docs/index.rst
index 86733f0..c09731a 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -19,26 +19,4 @@ Contents
reference
implementations
-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 DTCWT MATLAB toolbox.
-* Automatic selection of single versus double precision calculation.
-* Built-in support for the most common complex wavelet families.
-
-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>`.
-
.. vim:sw=4:sts=4:et
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/python-dtcwt.git
More information about the debian-science-commits
mailing list