Updated index.rst

Author: OmkarPathak

docs/README.md

@@ -0,0 +1,17 @@
+# Pygorithm
+
+A fun way to learn algorithms on the Go!
+Just import the module and start learning, it's that easy.
+
+```python
+
+    from pygorithm.sorting import bubble_sort
+
+    # This will print the code for bubble sort
+    print(bubble_sort.get_code())
+
+    myList = [12, 4, 2, 14, 3, 7, 5]
+
+    # to sort the list
+    sorted_list = bubble_sort.sort(myList)
+```

docs/conf.py

@@ -0,0 +1,39 @@
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys
+import os
+import shlex
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+sys.path.insert(0, os.path.abspath('..'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# 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.autodoc',
+    'sphinx.ext.coverage',
+    'sphinx.ext.viewcode',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+# source_suffix = ['.rst', '.md']
+source_suffix = '.md'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'README'

docs/index.rst

@@ -13,13 +13,13 @@ Quick Start Guide
 ::
 
     from pygorithm.sorting import bubble_sort
+    
     # This will print the code for bubble sort
     print(bubble_sort.get_code())
 
     myList = [12, 4, 2, 14, 3, 7, 5]
 
     # to sort the list
-
     sorted_list = bubble_sort.sort(myList)
 
 ---------------