Feature/update documentation

Update documentation

• use rst files instead of markdown
• no more autodoc2, fully replaced with autodoc
• updated the documentation, so less output from Vale or Sphinx (warning-wise)

gso/api/v1/imports.py

@@ -34,15 +34,15 @@ def import_site(site: SiteImportModel) -> Dict[str, Any]:
     """Import a site by running the import_site workflow.
 
     Args:
-    ----
+    -----
     site (SiteImportModel): The site information to be imported.
 
     Returns:
-    -------
+    --------
     dict: A dictionary containing the process id of the started process and detail message.
 
     Raises:
-    ------
+    -------
     HTTPException: If the site already exists or if there's an error in the process.
     """
     try:
@@ -63,15 +63,15 @@ def import_router(router_data: RouterImportModel) -> Dict[str, Any]:
     """Import a router by running the import_router workflow.
 
     Args:
-    ----
+    -----
     router_data (RouterImportModel): The router information to be imported.
 
     Returns:
-    -------
+    --------
     dict: A dictionary containing the process id of the started process and detail message.
 
     Raises:
-    ------
+    -------
     HTTPException: If there's an error in the process.
     """
 
@@ -84,15 +84,15 @@ def import_iptrunk(iptrunk_data: IptrunkImportModel) -> Dict[str, Any]:
     """Import an iptrunk by running the import_iptrunk workflow.
 
     Args:
-    ----
+    -----
     iptrunk_data (IptrunkImportModel): The iptrunk information to be imported.
 
     Returns:
-    -------
+    --------
     dict: A dictionary containing the process id of the started process and detail message.
 
     Raises:
-    ------
+    -------
     HTTPException: If there's an error in the process.
     """