readthedocs templates (#26)

* readthedocs templates

* docs templates

docs/source/function/function.rst

@@ -0,0 +1,20 @@
+API
+===
+
+
+
+Function findOverlaps
+#####################
+
+Joining datasets on ranges as key is frequently used in bioinformatics. Since dataset may consist of millions of elements a natural/brute-force solution is slow, inefficient and may not even 
+
+
+Using UDFs
+##########
+
+
+Additional parameteres
+######################
+
+
+

docs/source/implementation/implementation.rst

@@ -0,0 +1,5 @@
+Implementation details
+======================
+
+
+

docs/source/index.rst

@@ -3,18 +3,39 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to bdg-spark-granges's documentation!
-=============================================
+SeQuiLa documentation
+======================
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
+
+   quickstart/quickstart
+
+.. toctree::
+   :maxdepth: 2
+
+   overview/overview
+
+.. toctree::
+   :maxdepth: 3
+
+   usage/usage
+
+.. toctree::
+   :maxdepth: 2
+
+   function/function
+
+
+
+
+
 
 
 
-Indices and tables
-==================
+.. Indices and tables
+.. ==================
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+.. * :ref:`genindex`
+.. * :ref:`modindex`
+.. * :ref:`search`

docs/source/overview/overview.rst

@@ -0,0 +1,19 @@
+Overview
+========
+
+
+
+
+Motivation 
+###########
+
+Joining datasets on ranges as key is frequently used in bioinformatics. Since dataset may consist of millions of elements a natural/brute-force solution is slow, inefficient and may not even 
+
+
+Solution overview
+#################
+
+
+Methods and algorithms (Implementation)
+######################
+

docs/source/quickstart/quickstart.rst

@@ -0,0 +1,17 @@
+Quickstart 
+==========
+
+
+
+
+Test run at local machine
+#########################
+
+Prerequisities: Docker daemon installed and running. `<https://docs.docker.com/install/>`_
+
+in your commandline invoke:
+docker run --it -p 4040:4040 biodatageeks/bdg-toolset bdg-shell
+
+
+
+

docs/source/usage/usage.rst

@@ -0,0 +1,24 @@
+Usage
+=====
+
+Playing within docker container
+###############################
+fsfds
+
+
+Running at local machine
+**************************
+fsdfdsf
+
+Running at yarn
+*****************
+fsdfds
+
+
+Running as Spark Thrift Server
+##############################
+fsdfsd
+
+Integrating granges with Spark application
+##########################################
+fsf