DOC: update documentation for repo move to https://github.com/rgommer…

…s/pywt

CHANGES.txt

@@ -1,5 +1,10 @@
 Changelog
 
+0.3.0
+    A mojor refactoring, providing support for Python 3.x while maintaining
+    full backwards compatiblity.
+    Development has moved to https://github.com/rgommers/pywt
+
 0.2.2
     maintenance release:
       - resolved setup and build issues

README.rst

@@ -5,29 +5,37 @@ PyWavelets is a free Open Source wavelet transform software for Python_
 programming language. It is written in Python, Cython and C for a mix of easy
 and powerful high-level interface and the best performance.
 
-PyWavelets is very easy to start with and use, and currently is capable of:
+PyWavelets is very easy to start with and use. Just install the package, open
+the Python interactive shell and type:
+
+  .. sourcecode:: python
+
+    >>> import pywt
+    >>> cA, cD = pywt.dwt([1, 2, 3, 4], 'db1')
+
+Voilà! Computing wavelet transforms never before has been so simple :)
+
+Main features
+-------------
+
+The main features of PyWavelets are:
 
   * 1D and 2D Forward and Inverse Discrete Wavelet Transform (DWT and IDWT)
   * 1D and 2D Stationary Wavelet Transform (Undecimated Wavelet Transform)
   * 1D and 2D Wavelet Packet decomposition and reconstruction
   * Approximating wavelet and scaling functions
-  * Over seventy built-in wavelet filters and custom wavelets supported
+  * Over seventy `built-in wavelet filters`_
+    and custom wavelets supported
   * Single and double precision calculations
-  * Results compatibility with Matlab Wavelet Toolbox (tm)
-
-.. image::
-    https://secure.travis-ci.org/rgommers/pywt.png?branch=master
-    :alt: Build Status
-    :target: https://secure.travis-ci.org/rgommers/pywt
-
+  * Results compatibility with Matlab Wavelet Toolbox |tm|
 
 Requirements
 ------------
 
 PyWavelets is a package for the Python programming language. It requires:
 
- - Python_ 2.6, 2.7 or >=3.2
- - Numpy_ 
+ - Python_ 2.6, 2.7 or >=3.3
+ - Numpy_ >= 1.6.2
 
 Download
 --------
@@ -36,18 +44,16 @@ The most recent *development* version can be found on GitHub at
 https://github.com/rgommers/pywt.
 
 Latest release, including source and binary package for Windows, is available
-for download from the `Python Package Index`_.  Note that the official release
-is quite old and doesn't yet support Python 3.
+for download from the `Python Package Index`_ or on 
+`https://github.com/rgommers/pywt/releases`__
 
 Install
 -------
 
 In order to build PyWavelets from source, a working C compiler (GCC or MSVC)
 and a recent version of Cython_ is required.
 
- - To install PyWavelets open shell prompt and type 
-   ``pip install -e git+https://github.com/rgommers/pywt#egg=pywt`` (dev version)
-   or ``pip install PyWavelets`` (last official release)
+ - Install PyWavelets with ``pip install PyWavelets``.
 
  - To build and install from source, navigate to downloaded PyWavelets source
    code directory and type ``python setup.py install``.
@@ -59,6 +65,9 @@ Binary packages for several Linux distributors are maintained by Open Source
 community contributors. Query your Linux package manager tool
 for `python-wavelets`, `python-pywt` or similar package name.
 
+.. seealso::  :ref:`Development notes <dev-index>` section contains more
+              information on building and installing from source code.
+
 Documentation
 -------------
 
@@ -68,53 +77,60 @@ http://pywavelets.readthedocs.org.
 
 For more usage examples see the `demo`_ directory in the source package.
 
-Contributing
-------------
+State of development & Contributing
+-----------------------------------
 
 PyWavelets started in 2006 as an academic project for a master thesis
 on `Analysis and Classification of Medical Signals using Wavelet Transforms`
-but seems to no longer be maintained by its `original developer`_.
-This repo contains further development work by multiple contributors.
+and was maintained until 2012 by its `original developer`_.  In 2013
+maintenance was taken over in a new repo (`https://github.com/rgommers/pywt`__)
+by a larger development teams with stated support from the original developer.
+At the moment it's not yet clear if that repo will become a full fork under a
+new name or if the PyWavelets name can be kept.  The latter is preferred but
+requires permission from the original developer (see 
+`https://github.com/nigma/pywt/issues/13`__  for current status on this issue).
 
 All contributions including bug reports, bug fixes, new feature implementations
-and documentation improvements are welcome.
+and documentation improvements are welcome.  Moreover, developers with an
+interest in PyWavelets are very welcome to join the development team!
+
 
 Python 3
 --------
 
-Python 2.x and Python 3.x versions are working under the
-same code base at https://github.com/rgommers/pywt, as well as the examples. 
-Check out the `changelog <https://github.com/rgommers/pywt>`_ for
-info.
-
-Issues should be reported on https://github.com/rgommers/pywt/issues.
+Python 3.x is fully supported from release v0.3.0 on.
 
 Contact
 -------
 
-Use `GitHub Issues`_ or the `PyWavelets discussions group`_ to post your
+Use `GitHub Issues`_ or `PyWavelets discussions group`_ to post your
 comments or questions.
 
 License
 -------
 
 PyWavelets is a free Open Source software released under the MIT license.
 
-Commercial Support
-------------------
+Contents
+--------
+
+.. toctree::
+   :maxdepth: 1
 
-For information on commercial support and development one can try to contact
-the original developer at [email protected].
+   ref/index
+   regression/index
+   dev/index
+   resources
+   contents
 
 
+.. _built-in wavelet filters: http://wavelets.pybytes.com/
 .. _Cython: http://cython.org/
-.. _demo: https://github.com/nigma/pywt/tree/master/demo
-.. _GitHub: https://github.com/rgommers/pywt/issues
-.. _GitHub Issues: https://github.com/nigma/pywt/issues
-.. _in-development version: https://github.com/nigma/pywt/tarball/develop#egg=PyWavelets-dev
-.. _Numpy: http://numpy.scipy.org/
+.. _demo: https://github.com/rgommers/pywt/tree/master/demo
+.. _GitHub: https://github.com/rgommers/pywt
+.. _GitHub Issues: https://github.com/rgommers/pywt/issues
+.. _Numpy: http://www.numpy.org
 .. _original developer: http://en.ig.ma
 .. _Python: http://python.org/
 .. _Python Package Index: http://pypi.python.org/pypi/PyWavelets/
 .. _PyWavelets discussions group: http://groups.google.com/group/pywavelets
-

doc/source/dev/testing.rst

@@ -6,15 +6,15 @@ Testing
 Continous integration with Travis-CI
 ------------------------------------
 
-The project is using `Travis-CI <http://travis-ci.org/#!/nigma/pywt>`_ service
+The project is using `Travis-CI <https://travis-ci.org/rgommers/pywt>`_ service
 for continous integration and testing.
 
 Current build status is:
 
 .. image::
-    https://secure.travis-ci.org/nigma/pywt.png?branch=develop
+    https://secure.travis-ci.org/rgommers/pywt.png?branch=develop
     :alt: Build Status
-    :target: https://secure.travis-ci.org/nigma/pywt
+    :target: https://secure.travis-ci.org/rgommers/pywt
 
 
 If you are submitting a patch or pull request please make sure it
@@ -24,18 +24,23 @@ does not break the build.
 Running tests locally
 ---------------------
 
-Simply::
+Tests are implemented with `nose`_, so use one of:
 
-  python setup.py test
+    $ nosetests pywt
+
+    >>> pywt.test()
 
 
 Running tests with Tox
 ----------------------
 
-There's also a config file for running tests with Tox (``pip install tox``)::
+There's also a config file for running tests with `Tox`_ (``pip install tox``).
+To for example run tests for Python 2.7 and Python 3.4 use::
+
+  tox -e py27,py34
+
+For more information see the `Tox`_ documentation.
 
-  tox
 
-It is not however very convenient at the moment because Tox recreates
-the test environment (which is a good thing) and builds numpy from
-source on every run (which takes a lot of time).
+.. _nose: http://nose.readthedocs.org/en/latest/ 
+.. _Tox: http://tox.testrun.org/ 

doc/source/index.rst

@@ -34,33 +34,30 @@ Requirements
 
 PyWavelets is a package for the Python programming language. It requires:
 
- - Python_ 2.6 or 2.7
- - numpy_ numeric array module
+ - Python_ 2.6, 2.7 or >=3.3
+ - Numpy_ >= 1.6.2
 
 Download
 --------
 
 The most recent *development* version can be found on GitHub at
-https://github.com/nigma/pywt.
+https://github.com/rgommers/pywt.
 
 Latest release, including source and binary package for Windows, is available
-for download from the `Python Package Index`_.
+for download from the `Python Package Index`_ or on 
+`https://github.com/rgommers/pywt/releases`__
 
 Install
 -------
 
 In order to build PyWavelets from source, a working C compiler (GCC or MSVC)
 and a recent version of Cython_ is required.
 
- - To install PyWavelets open shell prompt and type ``pip install PyWavelets``
-   or ``easy_install PyWavelets``.
+ - Install PyWavelets with ``pip install PyWavelets``.
 
  - To build and install from source, navigate to downloaded PyWavelets source
    code directory and type ``python setup.py install``.
 
- - The `in-development version`_ of PyWavelets can be installed with
-   ``pip install PyWavelets==dev`` or ``easy_install PyWavelets==dev``.
-
 Prebuilt Windows binaries and source code packages are also
 available from `Python Package Index`_.
 
@@ -80,25 +77,28 @@ http://pywavelets.readthedocs.org.
 
 For more usage examples see the `demo`_ directory in the source package.
 
-Contributing
-------------
+State of development & Contributing
+-----------------------------------
 
 PyWavelets started in 2006 as an academic project for a master thesis
 on `Analysis and Classification of Medical Signals using Wavelet Transforms`
-and is maintained by its `original developer`_.
+and was maintained until 2012 by its `original developer`_.  In 2013
+maintenance was taken over in a new repo (`https://github.com/rgommers/pywt`__)
+by a larger development teams with stated support from the original developer.
+At the moment it's not yet clear if that repo will become a full fork under a
+new name or if the PyWavelets name can be kept.  The latter is preferred but
+requires permission from the original developer (see 
+`https://github.com/nigma/pywt/issues/13`__  for current status on this issue).
 
 All contributions including bug reports, bug fixes, new feature implementations
-and documentation improvements are welcome.
+and documentation improvements are welcome.  Moreover, developers with an
+interest in PyWavelets are very welcome to join the development team!
 
-Go and fork on `GitHub`_ today!
 
 Python 3
 --------
 
-Python 3 development branch is at https://github.com/nigma/pywt/tree/py-3.
-Check out the `changelog <https://github.com/nigma/pywt/commits/py-3>`_ for
-info. Currently the code and examples are ported to work on Python 2.7 and 3.2
-from the same codebase.
+Python 3.x is fully supported from release v0.3.0 on.
 
 Contact
 -------
@@ -111,16 +111,6 @@ License
 
 PyWavelets is a free Open Source software released under the MIT license.
 
-Commercial Support
-------------------
-
-For information on commercial support and development email me at [email protected].
-
-
-.. |tm| unicode:: U+2122 .. trademark sign
-    :ltrim:
-
-
 Contents
 --------
 
@@ -136,11 +126,10 @@ Contents
 
 .. _built-in wavelet filters: http://wavelets.pybytes.com/
 .. _Cython: http://cython.org/
-.. _demo: https://github.com/nigma/pywt/tree/master/demo
-.. _GitHub: https://github.com/nigma/pywt
-.. _GitHub Issues: https://github.com/nigma/pywt/issues
-.. _in-development version: https://github.com/nigma/pywt/tarball/develop#egg=PyWavelets-dev
-.. _numpy: http://numpy.scipy.org/
+.. _demo: https://github.com/rgommers/pywt/tree/master/demo
+.. _GitHub: https://github.com/rgommers/pywt
+.. _GitHub Issues: https://github.com/rgommers/pywt/issues
+.. _Numpy: http://www.numpy.org
 .. _original developer: http://en.ig.ma
 .. _Python: http://python.org/
 .. _Python Package Index: http://pypi.python.org/pypi/PyWavelets/

doc/source/resources.rst

@@ -35,7 +35,7 @@ Articles
  - `Wavelet Regression in Python <http://jseabold.net/blog/2012/02/wavelet-regression-in-python.html>`_
 
 
-.. _GitHub repository: https://github.com/nigma/pywt
-.. _GitHub Issues: https://github.com/nigma/pywt/issues
+.. _GitHub repository: https://github.com/rgommers/pywt
+.. _GitHub Issues: https://github.com/rgommers/pywt/issues
 .. _PyWavelets discussions group: http://groups.google.com/group/pywavelets
 .. _wavelets.pybytes.com: http://wavelets.pybytes.com/