[python-dtcwt] 108/497: make the contents page more prominent in the documentation

[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 cadc858d42011008cf4628b8a72ed3a7c2b1983f
Author: Rich Wareham <rjw57 at cam.ac.uk>
Date:   Sat Aug 17 17:43:27 2013 +0100

    make the contents page more prominent in the documentation
    
    The contents page should be highly visible since it will be the first
    thing someone is going to look for when building the library.
---
 docs/gettingstarted.rst | 41 ++++++++++++++++++++++++++++++++++++++
 docs/index.rst          | 52 +++++++------------------------------------------
 2 files changed, 48 insertions(+), 45 deletions(-)

diff --git a/docs/gettingstarted.rst b/docs/gettingstarted.rst
index 693c73c..8650a85 100644
--- a/docs/gettingstarted.rst
+++ b/docs/gettingstarted.rst
@@ -14,6 +14,47 @@ installed, you are most likely to use one of these functions:
 See :doc:`reference` for full details on how to call these functions. We shall
 present some simple usage below.
 
+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.
+
+Building the documentation
+``````````````````````````
+
+There is `a pre-built <https://dtcwt.readthedocs.org/>`_ version of this
+documentation available online and you can build your own copy via the Sphinx
+documentation system:
+
+.. code-block:: console
+
+    $ python setup.py build_sphinx
+
+Compiled documentation may be found in ``build/docs/html/``.
+
 1D transform
 ------------
 
diff --git a/docs/index.rst b/docs/index.rst
index 7d516fb..0bb8574 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -25,44 +25,16 @@ 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.
 
-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
-`````````````````````
+Contents
+````````
 
-There is `more documentation <https://dtcwt.readthedocs.org/>`_
-available online and you can build your own copy via the Sphinx documentation
-system::
+.. toctree::
+    :maxdepth: 1
 
-    $ python setup.py build_sphinx
+    gettingstarted
+    examples
+    reference
 
-Compiled documentation may be found in ``build/docs/html/``.
 
 Licence
 ```````
@@ -75,14 +47,4 @@ 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>`.
 
-Contents
-`````````````````
-
-.. toctree::
-    :maxdepth: 1
-
-    gettingstarted
-    examples
-    reference
-
 .. 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