Merge pull request #216 from vlad-ro/fix-docs-formatting

Fix docs formatting

Author: Anand Sanmukhani

prometheus_api_client/metric.py

@@ -18,28 +18,30 @@ 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: (datetime|timedelta) Any metric values in the dataframe that are \
-                    older than this value will be deleted when new data is added to the dataframe \
+    :param oldest_data_datetime: (datetime|timedelta) 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.
 
-                    * `oldest_data_datetime=datetime.timedelta(days=2)`, will delete the \
-                    metric data that is 2 days older than the latest metric. \
-                    The dataframe is pruned only when new data is added to it. \n
-                    * `oldest_data_datetime=datetime.datetime(2019,5,23,12,0)`, will delete \
-                    any data that is older than "23 May 2019 12:00:00" \n
-                    * `oldest_data_datetime=datetime.datetime.fromtimestamp(1561475156)` \
-                    can also be set using the unix timestamp
+                    * `oldest_data_datetime=datetime.timedelta(days=2)`, will delete the
+                      metric data that is 2 days older than the latest metric.
+                      The dataframe is pruned only when new data is added to it.
+                    * `oldest_data_datetime=datetime.datetime(2019,5,23,12,0)`, will delete
+                      any data that is older than "23 May 2019 12:00:00"
+                    * `oldest_data_datetime=datetime.datetime.fromtimestamp(1561475156)`
+                      can also be set using the unix timestamp
 
     Example Usage:
-        ``prom = PrometheusConnect()``
+      .. code-block:: python
 
-        ``my_label_config = {'cluster': 'my_cluster_id', 'label_2': 'label_2_value'}``
+          prom = PrometheusConnect()
 
-        ``metric_data = prom.get_metric_range_data(metric_name='up', label_config=my_label_config)``
-        ``Here metric_data is a list of metrics received from prometheus``
+          my_label_config = {'cluster': 'my_cluster_id', 'label_2': 'label_2_value'}
 
-        ``# only for the first item in the list``
-        ``my_metric_object = Metric(metric_data[0], datetime.timedelta(days=10))``
+          metric_data = prom.get_metric_range_data(metric_name='up', label_config=my_label_config)
+          # Here metric_data is a list of metrics received from prometheus
+
+          # only for the first item in the list
+          my_metric_object = Metric(metric_data[0], datetime.timedelta(days=10))
 
     """
 
@@ -85,11 +87,13 @@ def __eq__(self, other):
         Check whether two metrics are the same (are the same time-series regardless of their data)
 
         Example Usage:
-            ``metric_1 = Metric(metric_data_1)``
+          .. code-block:: python
+
+              metric_1 = Metric(metric_data_1)
 
-            ``metric_2 = Metric(metric_data_2)``
+              metric_2 = Metric(metric_data_2)
 
-            ``print(metric_1 == metric_2) # will print True if they belong to the same time-series``
+              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
@@ -103,9 +107,11 @@ def __str__(self):
         Make it print in a cleaner way when print function is used on a Metric object.
 
         Example Usage:
-            ``metric_1 = Metric(metric_data_1)``
+          .. code-block:: python
+
+              metric_1 = Metric(metric_data_1)
 
-            ``print(metric_1) # will print the name, labels and the head of the dataframe``
+              print(metric_1) # will print the name, labels and the head of the dataframe
 
         """
         name = "metric_name: " + repr(self.metric_name) + "\n"
@@ -130,11 +136,11 @@ def __add__(self, other):
                                             # 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
+        :return: (`Metric`) Returns a `Metric` object with the combined metric data
+          of the two added metrics
 
-        :raises: (TypeError) Raises an exception when two metrics being added are \
-        from different metric time-series
+        :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/prometheus_connect.py

@@ -124,11 +124,13 @@ def get_current_metric_value(
             (PrometheusApiClientException) Raises in case of non 200 response status code
 
         Example Usage:
-            ``prom = PrometheusConnect()``
+          .. code-block:: python
 
-            ``my_label_config = {'cluster': 'my_cluster_id', 'label_2': 'label_2_value'}``
+              prom = PrometheusConnect()
 
-            ``prom.get_current_metric_value(metric_name='up', label_config=my_label_config)``
+              my_label_config = {'cluster': 'my_cluster_id', 'label_2': 'label_2_value'}
+
+              prom.get_current_metric_value(metric_name='up', label_config=my_label_config)
         """
         params = params or {}
         data = []
@@ -400,21 +402,23 @@ def get_metric_aggregation(
         the result of the query and the values are extracted from the result.
 
         :param query: (str) This is a PromQL query, a few examples can be found
-        at https://prometheus.io/docs/prometheus/latest/querying/examples/
+          at https://prometheus.io/docs/prometheus/latest/querying/examples/
         :param operations: (list) A list of operations to perform on the values.
-        Operations are specified in string type.
+          Operations are specified in string type.
         :param start_time: (datetime) A datetime object that specifies the query range start time.
         :param end_time: (datetime) A datetime object that specifies the query range end time.
         :param step: (str) Query resolution step width in duration format or float number of seconds
         :param params: (dict) Optional dictionary containing GET parameters to be
-        sent along with the API request, such as "timeout"
-        Available operations - sum, max, min, variance, nth percentile, deviation
-        and average.
+          sent along with the API request, such as "timeout"
+          Available operations - sum, max, min, variance, nth percentile, deviation
+          and average.
 
         :returns: (dict) A dict of aggregated values received in response to the operations
-        performed on the values for the query sent.
+          performed on the values for the query sent.
+
+        Example output:
+          .. code-block:: python
 
-        Example output :
             {
                 'sum': 18.05674,
                 'max': 6.009373