Minor changes to documentation

2016-03-26 01:32:56 +00:00
parent b5fa78bee8
commit ef0db24f0d
3 changed files with 8 additions and 11 deletions
@@ -1,10 +1,15 @@
-Examples
-========
+API Usage Examples
+==================

 WARNING: As examples use the same files, only one notebook can be run at a
 time. Make sure one notebook has been closed and halted before starting the
 next.

+This section contains three examples of how to use the API for creating and
+comparing audio databases. Examples have been created using Jupyter interactive
+notebooks that can be found in the project folder and used to step through the
+code line by line interactively to see results.
+
 .. toctree::
   :maxdepth: 2

@@ -15,12 +15,3 @@ Welcome to Concatenator's documentation!
   api
   descriptor_defs
   examples
-
-
-
-
-Indices
-==================
-
-* :ref:`genindex`
-
@@ -9,6 +9,7 @@ There are a few dependencies required to install concatenator:
 1. Python 2.7.11 (It will probably run on earlier versions)
 2. libsndfile - used for audio file IO
 3. The HDF5 Library - used for large file storage
+4. The Sox audio library - used for pitch shifting

 Brew Python
 +++++++++++