remove old notebook files, update sphinx docs

docs/conf.py

@@ -21,8 +21,6 @@
 sys.path.insert(0, os.path.abspath('../rltk'))
 sys.path.insert(0, os.path.abspath('../'))
 
-print sys.path
-
 
 # -- General configuration ------------------------------------------------
 

docs/index.rst

@@ -16,28 +16,14 @@ Getting Started
 
 Installation (need to upload to PyPI later)::
 
-   pip install rltk
+   pip install -U rltk
 
-Example 1::
+Example::
 
    >>> import rltk
-   >>> tk = rltk.init()
-   >>> tk.levenshtein_distance('abc', 'abd')
+   >>> rltk.levenshtein_distance('abc', 'abd')
    1
 
-In RLTK, you can simply load the resource you need and give it a name, then reuse it by name in later methods.
-
-Example 2::
-
-   >>> import rltk
-   >>> tk = rltk.init()
-   >>> tk.levenshtein_distance('a', 'abc')
-   >>> 2
-   >>> edit_distance_cost = {'insert': {'c':50}, 'insert_default':100, 'delete_default':100, 'substitute_default':100}
-   >>> tk.load_edit_distance_table('A1', edit_distance_cost) # load resource
-   >>> tk.levenshtein_distance('a', 'abc', name='A1')
-   >>> 150
-
 More Examples
 -------------
 

docs/mod_record.rst

@@ -0,0 +1,5 @@
+Record
+======
+
+.. automodule:: rltk.record
+    :members:

docs/mod_similarity.rst

@@ -0,0 +1,52 @@
+Similarity
+==========
+
+Normal metrics
+--------------
+
+.. automodule:: rltk.similarity.equal
+    :members:
+
+.. automodule:: rltk.similarity.hamming
+    :members:
+
+.. automodule:: rltk.similarity.dice
+    :members:
+
+.. automodule:: rltk.similarity.levenshtein
+    :members:
+
+.. automodule:: rltk.similarity.needleman
+    :members:
+
+.. automodule:: rltk.similarity.jaro
+    :members:
+
+.. automodule:: rltk.similarity.jaccard
+    :members:
+
+.. automodule:: rltk.similarity.cosine
+    :members:
+
+.. automodule:: rltk.similarity.tf_idf
+    :members:
+
+
+Hybrid metrics
+--------------
+
+.. automodule:: rltk.similarity.hybrid
+    :members:
+
+
+Phonetic metrics
+----------------
+
+.. automodule:: rltk.similarity.soundex
+    :members:
+
+.. automodule:: rltk.similarity.metaphone
+    :members:
+
+.. automodule:: rltk.similarity.nysiis
+    :members:

docs/modules.rst

@@ -1,7 +1,13 @@
-RLTK
+API Reference
 =================
 
 .. toctree::
    :maxdepth: 4
 
-   rltk
+   mod_dataset.rst
+   mod_record.rst
+   mod_similarity.rst
+..   mod_io.rst
+..   mod_blocking.rst
+..   mod_tokenizer.rst
+..   mod_evaluation.rst