Merge branch 'feature/fix-docsstring' into 'develop'

GLOB-12189 fix build for readthedocs

See merge request core/sevenbridges-python!109

.readthedocs.yaml

@@ -0,0 +1,13 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.9"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py

docs/quickstart.rst

@@ -347,6 +347,7 @@ For user management in divisions and teams, the following are available:
 For disabling users:
 
 .. code-block:: python
+
     user = api.users.get('<username>')
     user.disable()
 

docs/sevenbridges.models.rst

@@ -32,10 +32,18 @@ sevenbridges\.models\.app module
     :undoc-members:
     :show-inheritance:
 
-sevenbridges\.models\.billing\_breakdown module
------------------------------------------------
+sevenbridges\.models\.billing\_egress\_breakdown module
+-------------------------------------------------------
+
+.. automodule:: sevenbridges.models.billing_egress_breakdown
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+sevenbridges\.models\.billing\_storage\_breakdown module
+--------------------------------------------------------
 
-.. automodule:: sevenbridges.models.billing_breakdown
+.. automodule:: sevenbridges.models.billing_storage_breakdown
     :members:
     :undoc-members:
     :show-inheritance:

sevenbridges/api.py

@@ -31,7 +31,9 @@
 
 
 class Api(HttpClient):
-    """Api aggregates all resource classes into single place"""
+    """
+    Api aggregates all resource classes into single place
+    """
 
     actions = Actions
     apps = App

sevenbridges/models/file.py

@@ -387,8 +387,7 @@ def content(self, path=None, overwrite=True, encoding='utf-8'):
         """
         Downloads file to the specified path or as temporary file
         and reads the file content in memory.
-         Should not be used on very large files.
-
+        Should not be used on very large files.
         :param path: Path for file download If omitted tmp file will be used.
         :param overwrite: Overwrite file if exists locally
         :param encoding: File encoding, by default it is UTF-8

sevenbridges/models/storage_import.py

@@ -72,14 +72,13 @@ def submit_import(cls, volume, location, project=None, name=None,
         :param overwrite: If true it will overwrite file if exists.
         :param properties: Properties dictionary.
         :param parent: The ID of the target folder to which the item should be
-            imported. Should not be used together with project.
+        imported. Should not be used together with project.
         :param preserve_folder_structure: Whether to keep the exact source
-            folder structure. The default value is true if the item being
-            imported is a folder. Should not be used if you are importing
-            a file.
+        folder structure. The default value is true if the item being imported
+        is a folder. Should not be used if you are importing a file.
         :param autorename: Whether to automatically rename the item
-            (by prefixing its name with an underscore and number) if
-            another one with the same name already exists at the destination.
+        (by prefixing its name with an underscore and number) if
+        another one with the same name already exists at the destination.
         :param api: Api instance.
         :return: Import object.
         """

sevenbridges/models/task.py

@@ -425,12 +425,13 @@ def bulk_get(cls, tasks, api=None):
         return TaskBulkRecord.parse_records(response=response, api=api)
 
     def wait(self=None, period=10, callback=None, *args, **kwargs):
-        """Wait until task is complete
+        """
+        Wait until task is complete
         :param period: Time in seconds between reloads
         :param callback: Function to call after the task has finished,
-            arguments and keyword arguments can be provided for it
+        arguments and keyword arguments can be provided for it
         :return: Return value of provided callback function or None if a
-            callback function was not provided
+        callback function was not provided
         """
         while self.status not in TaskStatus.terminal_states:
             self.reload()