Merge pull request #584 from superannotateai/1852_implementation

VaghinakDev · web-flow · commit e354c832be34 · 2023-03-21T19:16:45.000+04:00
added folder section in docs
diff --git a/docs/source/api_reference/api_client.rst b/docs/source/api_reference/api_client.rst
@@ -9,6 +9,7 @@ Contents
     :maxdepth: 8
 
     api_project
+    api_folder
     api_item
     api_annotation
     api_annotation_class
diff --git a/docs/source/api_reference/api_folder.rst b/docs/source/api_reference/api_folder.rst
@@ -0,0 +1,11 @@
+=======
+Folders
+=======
+
+.. automethod:: superannotate.SAClient.search_folders
+.. automethod:: superannotate.SAClient.assign_folder
+.. automethod:: superannotate.SAClient.unassign_folder
+.. automethod:: superannotate.SAClient.get_folder_by_id
+.. automethod:: superannotate.SAClient.get_folder_metadata
+.. automethod:: superannotate.SAClient.create_folder
+.. automethod:: superannotate.SAClient.delete_folders
diff --git a/docs/source/api_reference/api_image.rst b/docs/source/api_reference/api_image.rst
@@ -1,6 +1,6 @@
-==========
+======
 Images
-==========
+======
 
 
 .. _ref_search_images:
diff --git a/docs/source/api_reference/api_project.rst b/docs/source/api_reference/api_project.rst
@@ -1,27 +1,19 @@
-==========
+========
 Projects
-==========
+========
 .. _ref_projects:
 .. _ref_search_projects:
-.. automethod:: superannotate.SAClient.search_projects
 .. automethod:: superannotate.SAClient.create_project
+.. automethod:: superannotate.SAClient.search_projects
 .. automethod:: superannotate.SAClient.create_project_from_metadata
 .. automethod:: superannotate.SAClient.clone_project
-.. automethod:: superannotate.SAClient.delete_project
 .. automethod:: superannotate.SAClient.rename_project
+.. automethod:: superannotate.SAClient.delete_project
 .. _ref_get_project_metadata:
 .. automethod:: superannotate.SAClient.get_project_by_id
 .. automethod:: superannotate.SAClient.set_project_status
 .. automethod:: superannotate.SAClient.get_project_metadata
 .. automethod:: superannotate.SAClient.get_project_image_count
-.. automethod:: superannotate.SAClient.search_folders
-.. automethod:: superannotate.SAClient.assign_folder
-.. automethod:: superannotate.SAClient.unassign_folder
-.. automethod:: superannotate.SAClient.get_folder_by_id
-.. automethod:: superannotate.SAClient.set_folder_status
-.. automethod:: superannotate.SAClient.get_folder_metadata
-.. automethod:: superannotate.SAClient.create_folder
-.. automethod:: superannotate.SAClient.delete_folders
 .. automethod:: superannotate.SAClient.upload_images_to_project
 .. automethod:: superannotate.SAClient.attach_items_from_integrated_storage
 .. automethod:: superannotate.SAClient.upload_image_to_project
@@ -32,5 +24,5 @@ Projects
 .. automethod:: superannotate.SAClient.add_contributors_to_project
 .. automethod:: superannotate.SAClient.get_project_settings
 .. automethod:: superannotate.SAClient.set_project_default_image_quality_in_editor
-.. automethod:: superannotate.SAClient.get_project_workflow
 .. automethod:: superannotate.SAClient.set_project_workflow
+.. automethod:: superannotate.SAClient.get_project_workflow
diff --git a/docs/source/api_reference/api_team.rst b/docs/source/api_reference/api_team.rst
@@ -1,6 +1,6 @@
-==========
+====
 Team
-==========
+====
 
 
 .. automethod:: superannotate.SAClient.get_team_metadata
