Add save_cog_with_dask to docs

opendatacube · Oct 17, 2023 · 9ef1bd1 · 9ef1bd1
1 parent 49ef5a2
commit 9ef1bd1
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -51,6 +51,20 @@ Interfacing with :py:class:`xarray.DataArray` and :py:class:`xarray.Dataset` cla
    write_cog
    compress
 
+odc.geo.cog
+***********
+
+Cloud Optimized GeoTIFF construction 
+
+.. currentmodule:: odc.geo.cog
+.. autosummary::
+   :toctree: _api/
+
+   save_cog_with_dask
+   cog_gbox
+   to_cog
+   write_cog
+   write_cog_layers
 
 odc.geo.geobox
 **************

diff --git a/odc/geo/cog/_tifffile.py b/odc/geo/cog/_tifffile.py
@@ -588,6 +588,24 @@ def save_cog_with_dask(
     stats: bool | int = True,
     **kw,
 ) -> Any:
+    """
+    Save cloud optimized geotiff to S3 or file.
+
+    :param xx: Pixels as :py:class:`xarray.DataArray` backed by Dask
+    :param dst: S3 url or a file path on shared storage
+    :param compression: Compression to use, default is ``DEFLATE``
+    :param level: compression "level", depends on chosen compression
+    :param predictor: TIFF predictor setting
+    :param compressionargs: Any other compression arguments
+    :param overview_resampling: Resampling to use for computing overviews
+    :param blocksize: Configure blocksizes for main and overview images
+    :param bigtiff: Generate BigTIFF by default, set to ``False`` to disable
+    :param aws: Configure AWS write access
+    :param client: Dask client
+    :param stats: Set to ``False`` to disable stats computation
+
+    :returns: Dask delayed
+    """
     # pylint: disable=import-outside-toplevel
     import dask.bag