Merge branch 'documenation-updates' into develop

README.rst

@@ -1,13 +1,17 @@
-PyWavelets Intro
-----------------
+PyWavelets - Discrete Wavelet Transform in Python
+=================================================
 
-PyWavelets is a Python wavelet transforms module that can do:
+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:
 
   * 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
-  * Computing Approximations of wavelet and scaling functions
-  * Over seventy built-in wavelet filters and support for custom wavelets
+  * Approximating wavelet and scaling functions
+  * Over seventy built-in wavelet filters and custom wavelets supported
   * Single and double precision calculations
   * Results compatibility with Matlab Wavelet Toolbox (tm)
 
@@ -16,43 +20,65 @@ PyWavelets is a Python wavelet transforms module that can do:
     :alt: Build Status
         :target: https://secure.travis-ci.org/nigma/pywt
 
+
+Requirements
+------------
+
+PyWavelets is a package for the Python programming language. It requires:
+
+ - Python_ 2.6 or 2.7
+ - numpy_ numeric array module
+
 Download
 --------
 
 The most recent *development* version can be found on GitHub at
 https://github.com/nigma/pywt.
 
-Latest release (not always up-to-date), including source and binary package for Windows,
-is available for download from the
-`Python Package Index <http://pypi.python.org/pypi/PyWavelets>`_.
+Latest release, including source and binary package for Windows, is available
+for download from the `Python Package Index`_.
 
 Install
 -------
 
 In order to build PyWavelets from source, a working C compiler (GCC or MSVC)
-and a recent version of Cython (http://cython.org/) is required.
+and a recent version of Cython_ is required.
 
  - To install PyWavelets open shell prompt and type ``pip install PyWavelets``
    or ``easy_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 <https://github.com/nigma/pywt/tarball/develop#egg=PyWavelets-dev>`_
-   of PyWavelets can be installed with ``pip install PyWavelets==dev``
-   or ``easy_install PyWavelets==dev``.
+ - 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 http://pypi.python.org/pypi/PyWavelets.
+available from `Python Package Index`_.
+
+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.
 
 Documentation
 -------------
 
-Documentation and links to more resources is available online
-at http://www.pybytes.com/pywavelets/.
+Documentation with detailed examples and links to more resources is available
+online at http://www.pybytes.com/pywavelets/.
+
+For more usage examples see the `demo`_ directory in the source package.
+
+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`_.
 
-For more usage examples see `demo <https://github.com/nigma/pywt/tree/master/demo>`_
-directory in the source package.
+All contributions including bug reports, bug fixes, new feature implementations
+and documentation improvements are welcome.
+
+Go and fork on `GitHub`_ today!
 
 Python 3
 --------
@@ -62,7 +88,28 @@ 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.
 
+Contact
+-------
+
+Use `GitHub Issues`_ or `PyWavelets discussions group`_ to post your
+comments or questions.
+
+To contact me directly email me at en@ig.ma.
+
 License
 -------
 
-PyWavelets is distributed under MIT license terms (see COPYING).
+PyWavelets is a free Open Source software released under the MIT license.
+
+
+.. _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/
+.. _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/_templates/editdocument.html

@@ -0,0 +1,42 @@
+{% set repo="nigma/pywt" %}
+{% set branch="develop" %}
+
+<div id="edit-instructions">
+    <h3>Edit this document</h3>
+    <p>
+        <a href="#" id="toggle-edit-info">
+        <img src="{{ pathto("_static/page_edit.png", 1) }}" height="16" width="16" alt="" />
+        The source code of this file is hosted on GitHub. Everyone can
+        update and fix errors in this document with few clicks -
+        no downloads needed.
+        </a>
+    </p>
+    <ol id="edit-info" style="display: none;">
+        <li>
+            Go to
+            <i><a href="https://github.com/{{ repo }}/blob/{{ branch }}/doc/source/{{ pagename }}.rst" target="_blank">
+                {{ title }}
+            </a></i> on GitHub.
+        </li>
+        <li>
+            Press <b>Edit this file</b> button.
+        </li>
+        <li>
+            Edit file contents using GitHub's text editor in your web browser
+        </li>
+        <li>
+            Fill in the <b>Commit message</b> text box at the end of the page
+            telling <i>why</i> you did the changes.
+            Press <b>Propose file change</b> button next to it when done.
+        </li>
+        <li>
+            On <i>Send a pull request</i> page you don't need to fill in text
+            anymore. Just press <b>Send pull request</b> button.
+        </li>
+        <li>
+            Your changes are now queued for review under project's
+            <a href="https://github.com/{{ repo }}/pulls" target="_blank">Pull requests</a> tab
+            on Github.
+        </li>
+    </ol>
+</div>

doc/source/_templates/page.html

@@ -0,0 +1,42 @@
+{# Drop version number from the HTML documentation title #}
+{%- set docstitle = "PyWavelets Documentation" %}
+
+{% extends "!page.html" %}
+
+{% block extrahead %}
+{{ super() }}
+<meta name="description" content="PyWavelets is a scientific Python module for Wavelet Transform calculations."/>
+<meta name="keywords" content="PyWavelets, wavelets, Python, wavelet transform, discrete wavelet transform, dwt, idwt, swt, wavelet packets, stationary wavelet transform, pywt, Filip Wasilewski"/>
+<meta name="author" content="Filip Wasilewski"/>
+<meta name="Distribution" content="Global"/>
+<meta name="Robots" content="INDEX,FOLLOW"/>
+
+<script type="text/javascript">
+    (function ($) {
+        $(document).ready(function () {
+            $("#toggle-edit-info").click(function (e) {
+                e.preventDefault();
+                $("#edit-info").toggle();
+            });
+        });
+    })(jQuery);
+</script>
+<script type="text/javascript">
+    var _gaq = _gaq || [];
+    _gaq.push(['_setAccount', 'UA-3396395-3']);
+    _gaq.push(['_trackPageview']);
+    (function () {
+        var ga = document.createElement('script');
+        ga.type = 'text/javascript';
+        ga.async = true;
+        ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+        var s = document.getElementsByTagName('script')[0];
+        s.parentNode.insertBefore(ga, s);
+    })();
+</script>
+{% endblock %}
+
+{# Remove version number from the top and bottom path bars #}
+{%- block rootrellink %}
+    <li><a href="{{ pathto(master_doc) }}">Home{{ reldelim1 }}</a></li>
+{%- endblock %}

doc/source/_templates/quicklinks.html

@@ -0,0 +1,12 @@
+<div>
+<h3>Python Development</h3>
+<p><a href="http://en.ig.ma/">Django web development for startups and businesses.</a></p>
+<p><a href="http://en.ig.ma/">Quality Python development and scientific applications.</a></p>
+<h3>Quick links</h3>
+<ul>
+<li><a href="https://github.com/nigma/pywt"><img src="{{ pathto("_static/github.png", 1) }}" height="16" width="16" alt="" /> Fork on Github</a></li>
+<li><a href="http://groups.google.com/group/pywavelets"><img src="{{ pathto("_static/comments.png", 1) }}" height="16" width="16" alt="" /> Discussion Group</a></li>
+<li><a href="http://wavelets.pybytes.com/"><img src="{{ pathto("_static/wave.png", 1) }}" height="16" width="16" alt="" /> Explore Wavelets</a></li>
+<li><a href="http://twitter.com/filipwasilewski"><img src="{{ pathto("_static/twitter.png", 1) }}" height="16" width="16" alt="" /> Follow on Twitter</a></li>
+</ul>
+</div>

doc/source/conf.py

@@ -24,7 +24,7 @@
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.doctest', 'sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.pngmath']
+extensions = ['sphinx.ext.doctest', 'sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.extlinks']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -39,8 +39,8 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'PyWavelets'
-copyright = jinja2.filters.do_mark_safe(u'2006-%s, <a href="http://filipwasilewski.pl/">Filip Wasilewski</a>' % datetime.date.today().year)
+project = 'PyWavelets'
+copyright = jinja2.filters.do_mark_safe('2006-%s, <a href="http://en.ig.ma/">Filip Wasilewski</a>' % datetime.date.today().year)
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -62,11 +62,11 @@
 #today_fmt = '%B %d, %Y'
 
 # List of documents that shouldn't be included in the build.
-unused_docs = ['substitutions']
+unused_docs = ['substitutions', 'overview']
 
 # List of directories, relative to source directory, that shouldn't be searched
 # for source files.
-exclude_trees = ['_build', '0.1.6']
+exclude_trees = ['_build']
 
 # The reST default role (used for this markup: `text`) to use for all documents.
 #default_role = None
@@ -86,14 +86,14 @@
 pygments_style = 'sphinx'
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+modindex_common_prefix = ['pywt.']
 
 
 # -- Options for HTML output ---------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  Major themes that come with
 # Sphinx are currently 'default' and 'sphinxdoc'.
-html_theme = 'default'
+html_theme = 'nature'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -134,6 +134,9 @@
 
 # Custom sidebar templates, maps document names to template names.
 #html_sidebars = {}
+html_sidebars = {
+   '**': ['localtoc.html', "relations.html", 'quicklinks.html', 'searchbox.html', 'editdocument.html'],
+}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
@@ -149,12 +152,12 @@
 #html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+html_show_sourcelink = False
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+html_use_opensearch = 'http://pybytes.com/pywavelets'
 
 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
 #html_file_suffix = ''
@@ -174,8 +177,8 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'PyWavelets.tex', u'PyWavelets Documentation',
-   u'Filip Wasilewski', 'manual'),
+  ('index', 'PyWavelets.tex', 'PyWavelets Documentation',
+   'Filip Wasilewski', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of

doc/source/contents.rst

@@ -0,0 +1,18 @@
+.. _contents:
+
+PyWavelets
+==========
+
+.. toctree::
+   :maxdepth: 2
+
+   ref/index
+   regression/index
+   dev/index
+   resources
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`