Add wasabi function to to docs

cositools · Feb 20, 2024 · a8af8c4 · a8af8c4
1 parent 7354b21
commit a8af8c4
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 8 deletions.
diff --git a/cosipy/util/data_fetching.py b/cosipy/util/data_fetching.py
@@ -13,18 +13,18 @@ def fetch_wasabi_file(file,
 
     Parameters
     ----------
-    file: str
+    file : str
         Full path to file in Wasabi
-    output: str
+    output : str,  optional
         Full path to the downloaded file in the local system. By default it will use 
         the current durectory and the same file name as the input file.
-    bucket: str
+    bucket : str, optional
         Passed to aws --bucket option
-    endpoint: str:
+    endpoint : str, optional
         Passed to aws --endpoint-url option
-    access_key: str
+    access_key : str, optional
         AWS_ACCESS_KEY_ID
-    secret_key: str
+    secret_key : str, optional
         AWS_SECRET_ACCESS_KEY
     """
 

diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -18,6 +18,6 @@ If you are instead interested in an overview on how to use cosipy, see out `tuto
    threeml
    ts_map
    image_deconvolution
+   util          
 
 
-
diff --git a/docs/api/util.rst b/docs/api/util.rst
@@ -0,0 +1,4 @@
+Utilities
+=========
+
+.. autofunction:: cosipy.util.fetch_wasabi_file
diff --git a/docs/conf.py b/docs/conf.py
@@ -65,7 +65,8 @@
                         'scoords',
                         'pandas',
                         'tqdm',
-                        'scipy']
+                        'scipy',
+                        'awscli']
 
 # There seems to be a conflict between unittest.mock (used by sphinx) and metaclasses
 # The cosipy.threeml.custom_functions.Band_Eflux includes a metaclass from
-Original file line number
+Diff line change
@@ Expand Up @@
        threeml
        ts_map
        image_deconvolution
+       util