Update documentation (#14)

* Update sphinx doc stuff

* Update docstring for MetricsList class for better sphinx documentation

Author: 4n4nd

docs/source/prometheus_api_client.rst

@@ -4,19 +4,36 @@ prometheus\_api\_client package
 Submodules
 ----------
 
+prometheus\_api\_client.metric module
+-------------------------------------
+
+.. automodule:: prometheus_api_client.metric
+   :members: Metric
+   :special-members: __add__, __eq__, __str__
+   :undoc-members:
+   :show-inheritance:
+
+prometheus\_api\_client.metrics\_list module
+--------------------------------------------
+
+.. automodule:: prometheus_api_client.metrics_list
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 prometheus\_api\_client.prometheus\_connect module
 --------------------------------------------------
 
 .. automodule:: prometheus_api_client.prometheus_connect
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 
 Module contents
 ---------------
 
 .. automodule:: prometheus_api_client
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

prometheus_api_client/metric.py

@@ -21,15 +21,14 @@ class Metric:
     A Class for `Metric` object
 
     :param metric: (dict) A metric item from the list of metrics received from prometheus
-    :param oldest_data_datetime: (str) So any metric values in the dataframe that are older than
-                    this value will be deleted when new data is added to the dataframe using
+    :param oldest_data_datetime: (str) Any metric values in the dataframe that are older than \
+                    this value will be deleted when new data is added to the dataframe using \
                     the __add__("+") operator.
-                    Example: oldest_data_datetime="10d", will delete the metric data that is older
-                            than 10 days. The dataframe is pruned only when new data is added to it.
 
-                             oldest_data_datetime="23 May 2019 12:00:00"
-
-                             oldest_data_datetime="1561475156" can be set using the unix timestamp
+                    * `oldest_data_datetime="10d"`, will delete the metric data that is older \
+                    than 10 days. The dataframe is pruned only when new data is added to it. \n
+                    * `oldest_data_datetime="23 May 2019 12:00:00"`\n
+                    * `oldest_data_datetime="1561475156"` can also be set using the unix timestamp
 
     Example Usage:
         ``prom = PrometheusConnect()``
@@ -64,20 +63,19 @@ def __init__(self, metric, oldest_data_datetime=None):
 
     def __eq__(self, other):
         """
-        overloading operator `=`
+        overloading operator ``=``
 
         Check whether two metrics are the same (are the same time-series regardless of their data)
 
-        :return: (bool) If two Metric objects belong to the same time-series,
-                 i.e. same name and label config, it will return True, else False
-
         Example Usage:
             ``metric_1 = Metric(metric_data_1)``
 
             ``metric_2 = Metric(metric_data_2)``
 
             ``print(metric_1 == metric_2) # will print True if they belong to the same time-series``
 
+        :return: (bool) If two Metric objects belong to the same time-series,
+                 i.e. same name and label config, it will return True, else False
         """
         return bool(
             (self.metric_name == other.metric_name) and (self.label_config == other.label_config)
@@ -101,18 +99,24 @@ def __str__(self):
 
     def __add__(self, other):
         """
-        overloading operator `+`
+        overloading operator ``+``,
         Add two metric objects for the same time-series
 
         Example Usage:
-            ``metric_1 = Metric(metric_data_1)``
+          .. code-block:: python
 
-            ``metric_2 = Metric(metric_data_2)``
+            metric_1 = Metric(metric_data_1)
+            metric_2 = Metric(metric_data_2)
+            metric_12 = metric_1 + metric_2 # will add the data in ``metric_2`` to ``metric_1``
+                                            # so if any other parameters are set in ``metric_1``
+                                            # will also be set in ``metric_12``
+                                            # (like ``oldest_data_datetime``)
+
+        :return: (`Metric`) Returns a `Metric` object with the combined metric data \
+        of the two added metrics
 
-            ``metric_12 = metric_1 + metric_2`` # will add the data in metric_2 to metric_1
-                                                # so if any other parameters are set in metric_1
-                                                # will also be set in metric_12
-                                                # (like `oldest_data_datetime`)
+        :raises: (TypeError) Raises an exception when two metrics being added are \
+        from different metric time-series
         """
         if self == other:
             new_metric = deepcopy(self)

prometheus_api_client/metrics_list.py

@@ -4,7 +4,23 @@
 
 
 class MetricsList(list):
-    """docstring for MetricsList."""
+    """A Class to initialize a list of Metric objects at once.
+
+    :param metric_data_list: (list|json) This is an individual metric or list of metrics received
+                             from prometheus as a result of a promql query.
+
+    Example Usage:
+      .. code-block:: python
+
+          prom = PrometheusConnect()
+          my_label_config = {'cluster': 'my_cluster_id', 'label_2': 'label_2_value'}
+          metric_data = prom.get_metric_range_data(metric_name='up', label_config=my_label_config)
+
+          metric_object_list = MetricsList(metric_data) # metric_object_list will be initialized as
+                                                        # a list of Metric objects for all the
+                                                        # metrics downloaded using get_metric query
+
+    """
 
     def __init__(self, metric_data_list):
         # if the input is not a list