Feature: Readthedocs support

.editorconfig

@@ -3,6 +3,7 @@ indent_style = space
 indent_size = 4
 insert_final_newline = true
 trim_trailing_whitespace = true
+end_of_line = lf
 
 [*.{json,yml,yaml}]
 indent_size = 2

.gitignore

@@ -39,3 +39,7 @@ tmp/
 
 # PyTest
 .cache/
+
+
+# Built docs
+docs/_build/

.vscode/settings.json

@@ -14,5 +14,6 @@
   "python.formatting.provider": "yapf",
   "python.formatting.yapfArgs": [
     "--style=.style.yapf"
-  ]
+  ],
+  "python.pythonPath": "${workspaceFolder}\\ENV\\Scripts\\python.exe"
 }

aztk/error.py

@@ -4,9 +4,15 @@
 """
 
 
-
 class AztkError(Exception):
+    """
+    Base class for all errors raised by the Aztk sdk
+    """
     def __init__(self, message: str = None):
+        """
+        :param message: Message of the exception
+        :type message: str
+        """
         super().__init__(message)
 
 class ClusterNotReadyError(AztkError):

aztk/internal/cluster_data/cluster_data.py

@@ -1,7 +1,6 @@
-import yaml
 import logging
+import yaml
 import azure.common
-from azure.storage.blob import BlockBlobService
 from .node_data import NodeData
 from .blob_data import BlobData
 
@@ -15,7 +14,7 @@ class ClusterData:
     APPLICATIONS_DIR = "applications"
     CLUSTER_CONFIG_FILE = "config.yaml"
 
-    def __init__(self, blob_client: BlockBlobService, cluster_id: str):
+    def __init__(self, blob_client, cluster_id: str):
         self.blob_client = blob_client
         self.cluster_id = cluster_id
         self._ensure_container()

aztk/internal/cluster_data/node_data.py

@@ -6,7 +6,7 @@
 import zipfile
 from pathlib import Path
 from typing import List
-from aztk.spark import models
+from aztk import models
 from aztk.utils import constants, file_utils, secure_utils
 from aztk.error import InvalidCustomScriptError
 

aztk/spark/client.py

@@ -16,13 +16,27 @@
 
 
 class Client(BaseClient):
+    """
+    Aztk Spark Client
+    This is the main entry point for using aztk for spark
+
+    Args:
+        secrets_config(aztk.spark.models.models.SecretsConfiguration): Configuration with all the needed credentials
+    """
     def __init__(self, secrets_config):
         super().__init__(secrets_config)
 
-    '''
-    Spark client public interface
-    '''
     def create_cluster(self, cluster_conf: models.ClusterConfiguration, wait: bool = False):
+        """
+        Create a new aztk spark cluster
+
+        Args:
+            cluster_conf(aztk.spark.models.models.ClusterConfiguration): Configuration for the the cluster to be created
+            wait(bool): If you should wait for the cluster to be ready before returning
+
+        Returns:
+            aztk.spark.models.Cluster
+        """
         cluster_conf.validate()
         cluster_data = self._get_cluster_data(cluster_conf.cluster_id)
         try:
@@ -202,7 +216,7 @@ def submit_job(self, job_configuration):
 
             autoscale_formula = "$TargetDedicatedNodes = {0}; " \
                                 "$TargetLowPriorityNodes = {1}".format(
-                                    job_configuration.max_dedicated_nodes, 
+                                    job_configuration.max_dedicated_nodes,
                                     job_configuration.max_low_pri_nodes)
 
             job = self.__submit_job(

aztk/spark/models/__init__.py

@@ -1 +1 @@
-from .models import *
+from .models import *

aztk/spark/models/plugins/__init__.py

@@ -1,4 +1,4 @@
-from .hdfs import *
-from .jupyter import *
-from .jupyter_lab import *
-from .rstudio_server import *
+from .hdfs import HDFSPlugin
+from .jupyter import JupyterPlugin
+from .jupyter_lab import JupyterLabPlugin
+from .rstudio_server import RStudioServerPlugin