snippet_provider_docs (#5)

* Changed format of docstrings to be better shown in docs

* Removed part of docs used as a tmp test

* Wrote snippet provider documentation

docs/contributing.rst

@@ -59,6 +59,40 @@ Snippet provider
 
 Provides snippets definitions from a database of snippets.
 
+Snippet definition files
+""""""""""""""""""""""""
+
+Snippets definition are writen in json files as shown is the following example.
+
+.. code-block:: json
+
+    [
+    {"name": "for","language": "C++","snippet": "for(#){$}"},
+    {"name": "if","language": "C++","snippet": "if(#){$}"}
+    ]
+
+Implementation
+""""""""""""""
+
+Snippet provider reads all the files containing snippets.
+It searches all json files contained in the given list of folders files.
+The list of folders is specified in the :code:`path` variable (similar to :code:`os.path`).
+
+.. autoclass:: homotopy.snippet_provider.SnippetProvider
+    :members: __getitem__, __init__
+    :member-order: bysource
+
+Usage
+"""""
+
+Using this class should be straightforward. Look.
+
+.. code-block:: python
+
+    provider = SnippetProvider("C++", ["folder1", "folder2"])
+    snippet = "for"
+    snippetExpansion = provider[snippet] # snippetExpansion == "for(#){$}" if used json from above
+
 Utilities
 ^^^^^^^^^
 

docs/index.rst

@@ -13,8 +13,4 @@ Homotopy documentation
    getting_started
    contributing
 
-This is a test for sphinx and Read the Docs. I will add documentation later.
-
-Testing Autodoc functionality:
-
-.. autoclass:: homotopy.snippet_provider.SnippetProvider
+Under development.

homotopy/snippet_provider.py

@@ -6,12 +6,13 @@
 class SnippetProvider:
     """
     Class for translating simple snippets into code.
-    Uses a database provided in json files located in path variable.
+    Uses a database provided in json files located in the path variable.
     """
 
     def __init__(self, language="", path=[]):
         """
         Initialize snippet provider instance.
+
         :param language: language to compile to
         :param path: list of directories to search for json files containing snippets
         """
@@ -31,7 +32,8 @@ def __init__(self, language="", path=[]):
 
     def __getitem__(self, item):
         """
-        Expand single snippet
+        Expand single snippet.
+
         :param item: snippet
         :return: snippet expansion
         """