Merge pull request #78 from ESA-PhiLab/autodoc

avoid skipping of first argument in module functions
ESA-PhiLab · Jan 5, 2022 · f2ab0b5 · f2ab0b5
2 parents b8d0f59 + ba274f7
commit f2ab0b5
Show file tree

Hide file tree

Showing 31 changed files with 155 additions and 155 deletions.
diff --git a/.gitignore b/.gitignore
@@ -131,3 +131,6 @@ dmypy.json
 
 # macOS
 .DS_Store
+
+# IDE 
+.vscode
diff --git a/.vscode/settings.json b/.vscode/settings.json
diff --git a/docs/source/modules/ost.generic.ard_to_ts.rst b/docs/source/modules/ost.generic.ard_to_ts.rst
@@ -11,9 +11,9 @@ ost.generic.ard\_to\_ts
       ard_to_ts
       gd_ard_to_ts
 
-.. automethod:: ost.generic.ard_to_ts.ard_to_ts
+.. autofunction:: ost.generic.ard_to_ts.ard_to_ts
 
-.. automethod:: ost.generic.ard_to_ts.gd_ard_to_ts
+.. autofunction:: ost.generic.ard_to_ts.gd_ard_to_ts
 
 
 

diff --git a/docs/source/modules/ost.generic.common_wrappers.rst b/docs/source/modules/ost.generic.common_wrappers.rst
@@ -16,19 +16,19 @@ ost.generic.common\_wrappers
       terrain_correction
       terrain_flattening
 
-.. automethod:: ost.generic.common_wrappers.create_stack
+.. autofunction:: ost.generic.common_wrappers.create_stack
 
-.. automethod:: ost.generic.common_wrappers.linear_to_db
+.. autofunction:: ost.generic.common_wrappers.linear_to_db
 
-.. automethod:: ost.generic.common_wrappers.ls_mask
+.. autofunction:: ost.generic.common_wrappers.ls_mask
 
-.. automethod:: ost.generic.common_wrappers.mt_speckle_filter
+.. autofunction:: ost.generic.common_wrappers.mt_speckle_filter
 
-.. automethod:: ost.generic.common_wrappers.speckle_filter
+.. autofunction:: ost.generic.common_wrappers.speckle_filter
 
-.. automethod:: ost.generic.common_wrappers.terrain_correction
+.. autofunction:: ost.generic.common_wrappers.terrain_correction
 
-.. automethod:: ost.generic.common_wrappers.terrain_flattening
+.. autofunction:: ost.generic.common_wrappers.terrain_flattening
 
 
 

diff --git a/docs/source/modules/ost.generic.mosaic.rst b/docs/source/modules/ost.generic.mosaic.rst
@@ -14,15 +14,15 @@ ost.generic.mosaic
       mosaic
       mosaic_slc_acquisition
 
-.. automethod:: ost.generic.mosaic.create_timeseries_mosaic_vrt
+.. autofunction:: ost.generic.mosaic.create_timeseries_mosaic_vrt
 
-.. automethod:: ost.generic.mosaic.gd_mosaic
+.. autofunction:: ost.generic.mosaic.gd_mosaic
 
-.. automethod:: ost.generic.mosaic.gd_mosaic_slc_acquisition
+.. autofunction:: ost.generic.mosaic.gd_mosaic_slc_acquisition
 
-.. automethod:: ost.generic.mosaic.mosaic
+.. autofunction:: ost.generic.mosaic.mosaic
 
-.. automethod:: ost.generic.mosaic.mosaic_slc_acquisition
+.. autofunction:: ost.generic.mosaic.mosaic_slc_acquisition
 
 
 

diff --git a/docs/source/modules/ost.generic.timescan.rst b/docs/source/modules/ost.generic.timescan.rst
@@ -16,19 +16,19 @@ ost.generic.timescan
       nan_percentile
       remove_outliers
 
-.. automethod:: ost.generic.timescan.date_as_float
+.. autofunction:: ost.generic.timescan.date_as_float
 
-.. automethod:: ost.generic.timescan.deseasonalize
+.. autofunction:: ost.generic.timescan.deseasonalize
 
-.. automethod:: ost.generic.timescan.difference_in_years
+.. autofunction:: ost.generic.timescan.difference_in_years
 
-.. automethod:: ost.generic.timescan.gd_mt_metrics
+.. autofunction:: ost.generic.timescan.gd_mt_metrics
 
-.. automethod:: ost.generic.timescan.mt_metrics
+.. autofunction:: ost.generic.timescan.mt_metrics
 
-.. automethod:: ost.generic.timescan.nan_percentile
+.. autofunction:: ost.generic.timescan.nan_percentile
 
-.. automethod:: ost.generic.timescan.remove_outliers
+.. autofunction:: ost.generic.timescan.remove_outliers
 
 
 

diff --git a/docs/source/modules/ost.generic.ts_extent.rst b/docs/source/modules/ost.generic.ts_extent.rst
@@ -10,7 +10,7 @@ ost.generic.ts\_extent
 
       mt_extent
 
-.. automethod:: ost.generic.ts_extent.mt_extent
+.. autofunction:: ost.generic.ts_extent.mt_extent
 
 
 

diff --git a/docs/source/modules/ost.generic.ts_ls_mask.rst b/docs/source/modules/ost.generic.ts_ls_mask.rst
@@ -10,4 +10,4 @@ ost.generic.ts\_ls\_mask
 
       mt_layover
 
-.. automethod:: ost.generic.ts_ls_mask.mt_layover
+.. autofunction:: ost.generic.ts_ls_mask.mt_layover
diff --git a/docs/source/modules/ost.helpers.asf.rst b/docs/source/modules/ost.helpers.asf.rst
@@ -14,15 +14,15 @@ ost.helpers.asf
       batch_download
       check_connection
 
-.. automethod:: ost.helpers.asf.asf_download
+.. autofunction:: ost.helpers.asf.asf_download
 
-.. automethod:: ost.helpers.asf.asf_download_parallel
+.. autofunction:: ost.helpers.asf.asf_download_parallel
 
-.. automethod:: ost.helpers.asf.ask_credentials
+.. autofunction:: ost.helpers.asf.ask_credentials
 
-.. automethod:: ost.helpers.asf.batch_download
+.. autofunction:: ost.helpers.asf.batch_download
 
-.. automethod:: ost.helpers.asf.check_connection
+.. autofunction:: ost.helpers.asf.check_connection
 
 
 

diff --git a/docs/source/modules/ost.helpers.asf_wget.rst b/docs/source/modules/ost.helpers.asf_wget.rst
@@ -20,11 +20,11 @@ ost.helpers.asf\_wget
 
       SessionWithHeaderRedirection
 
-.. automethod:: ost.helpers.asf_wget.batch_download
+.. autofunction:: ost.helpers.asf_wget.batch_download
 
-.. automethod:: ost.helpers.asf_wget.check_connection
+.. autofunction:: ost.helpers.asf_wget.check_connection
 
-.. automethod:: ost.helpers.asf_wget.s1_download
+.. autofunction:: ost.helpers.asf_wget.s1_download
 
 
 

diff --git a/docs/source/modules/ost.helpers.db.rst b/docs/source/modules/ost.helpers.db.rst
@@ -18,7 +18,7 @@ ost.helpers.db
 
       pgConnect
 
-.. automethod:: ost.helpers.db.pgHandler
+.. autofunction:: ost.helpers.db.pgHandler
 
 
 

diff --git a/docs/source/modules/ost.helpers.errors.rst b/docs/source/modules/ost.helpers.errors.rst
@@ -12,11 +12,11 @@ ost.helpers.errors
       GPTRuntimeError
       NotValidFileError
 
-.. automethod:: ost.helpers.errors.DownloadError
+.. autofunction:: ost.helpers.errors.DownloadError
 
-.. automethod:: ost.helpers.errors.GPTRuntimeError
+.. autofunction:: ost.helpers.errors.GPTRuntimeError
 
-.. automethod:: ost.helpers.errors.NotValidFileError
+.. autofunction:: ost.helpers.errors.NotValidFileError
 
 
 

diff --git a/docs/source/modules/ost.helpers.helpers.rst b/docs/source/modules/ost.helpers.helpers.rst
@@ -19,25 +19,25 @@ ost.helpers.helpers
       run_command
       timer
 
-.. automethod:: ost.helpers.helpers.check_out_dimap
+.. autofunction:: ost.helpers.helpers.check_out_dimap
 
-.. automethod:: ost.helpers.helpers.check_out_tiff
+.. autofunction:: ost.helpers.helpers.check_out_tiff
 
-.. automethod:: ost.helpers.helpers.check_zipfile
+.. autofunction:: ost.helpers.helpers.check_zipfile
 
-.. automethod:: ost.helpers.helpers.delete_dimap
+.. autofunction:: ost.helpers.helpers.delete_dimap
 
-.. automethod:: ost.helpers.helpers.delete_shapefile
+.. autofunction:: ost.helpers.helpers.delete_shapefile
 
-.. automethod:: ost.helpers.helpers.move_dimap
+.. autofunction:: ost.helpers.helpers.move_dimap
 
-.. automethod:: ost.helpers.helpers.remove_folder_content
+.. autofunction:: ost.helpers.helpers.remove_folder_content
 
-.. automethod:: ost.helpers.helpers.resolution_in_degree
+.. autofunction:: ost.helpers.helpers.resolution_in_degree
 
-.. automethod:: ost.helpers.helpers.run_command
+.. autofunction:: ost.helpers.helpers.run_command
 
-.. automethod:: ost.helpers.helpers.timer
+.. autofunction:: ost.helpers.helpers.timer
 
 
 

diff --git a/docs/source/modules/ost.helpers.onda.rst b/docs/source/modules/ost.helpers.onda.rst
@@ -14,15 +14,15 @@ ost.helpers.onda
       connect
       onda_download
 
-.. automethod:: ost.helpers.onda.ask_credentials
+.. autofunction:: ost.helpers.onda.ask_credentials
 
-.. automethod:: ost.helpers.onda.batch_download
+.. autofunction:: ost.helpers.onda.batch_download
 
-.. automethod:: ost.helpers.onda.check_connection
+.. autofunction:: ost.helpers.onda.check_connection
 
-.. automethod:: ost.helpers.onda.connect
+.. autofunction:: ost.helpers.onda.connect
 
-.. automethod:: ost.helpers.onda.onda_download
+.. autofunction:: ost.helpers.onda.onda_download
 
 
 

diff --git a/docs/source/modules/ost.helpers.peps.rst b/docs/source/modules/ost.helpers.peps.rst
@@ -14,15 +14,15 @@ ost.helpers.peps
       connect
       peps_download
 
-.. automethod:: ost.helpers.peps.ask_credentials
+.. autofunction:: ost.helpers.peps.ask_credentials
 
-.. automethod:: ost.helpers.peps.batch_download
+.. autofunction:: ost.helpers.peps.batch_download
 
-.. automethod:: ost.helpers.peps.check_connection
+.. autofunction:: ost.helpers.peps.check_connection
 
-.. automethod:: ost.helpers.peps.connect
+.. autofunction:: ost.helpers.peps.connect
 
-.. automethod:: ost.helpers.peps.peps_download
+.. autofunction:: ost.helpers.peps.peps_download
 
 
 

diff --git a/docs/source/modules/ost.helpers.raster.rst b/docs/source/modules/ost.helpers.raster.rst
@@ -29,45 +29,45 @@ ost.helpers.raster
       stretch_to_8bit
       visualise_rgb
 
-.. automethod:: ost.helpers.raster.calc_max
+.. autofunction:: ost.helpers.raster.calc_max
 
-.. automethod:: ost.helpers.raster.calc_min
+.. autofunction:: ost.helpers.raster.calc_min
 
-.. automethod:: ost.helpers.raster.combine_timeseries
+.. autofunction:: ost.helpers.raster.combine_timeseries
 
-.. automethod:: ost.helpers.raster.convert_to_db
+.. autofunction:: ost.helpers.raster.convert_to_db
 
-.. automethod:: ost.helpers.raster.create_rgb_jpeg
+.. autofunction:: ost.helpers.raster.create_rgb_jpeg
 
-.. automethod:: ost.helpers.raster.create_timeseries_animation
+.. autofunction:: ost.helpers.raster.create_timeseries_animation
 
-.. automethod:: ost.helpers.raster.create_tscan_vrt
+.. autofunction:: ost.helpers.raster.create_tscan_vrt
 
-.. automethod:: ost.helpers.raster.fill_internal_nans
+.. autofunction:: ost.helpers.raster.fill_internal_nans
 
-.. automethod:: ost.helpers.raster.get_max
+.. autofunction:: ost.helpers.raster.get_max
 
-.. automethod:: ost.helpers.raster.get_min
+.. autofunction:: ost.helpers.raster.get_min
 
-.. automethod:: ost.helpers.raster.image_bounds
+.. autofunction:: ost.helpers.raster.image_bounds
 
-.. automethod:: ost.helpers.raster.mask_by_shape
+.. autofunction:: ost.helpers.raster.mask_by_shape
 
-.. automethod:: ost.helpers.raster.norm
+.. autofunction:: ost.helpers.raster.norm
 
-.. automethod:: ost.helpers.raster.outline
+.. autofunction:: ost.helpers.raster.outline
 
-.. automethod:: ost.helpers.raster.polygonize_bounds
+.. autofunction:: ost.helpers.raster.polygonize_bounds
 
-.. automethod:: ost.helpers.raster.polygonize_ls
+.. autofunction:: ost.helpers.raster.polygonize_ls
 
-.. automethod:: ost.helpers.raster.rescale_to_float
+.. autofunction:: ost.helpers.raster.rescale_to_float
 
-.. automethod:: ost.helpers.raster.scale_to_int
+.. autofunction:: ost.helpers.raster.scale_to_int
 
-.. automethod:: ost.helpers.raster.stretch_to_8bit
+.. autofunction:: ost.helpers.raster.stretch_to_8bit
 
-.. automethod:: ost.helpers.raster.visualise_rgb
+.. autofunction:: ost.helpers.raster.visualise_rgb
 
 
 

diff --git a/docs/source/modules/ost.helpers.scihub.rst b/docs/source/modules/ost.helpers.scihub.rst
@@ -20,27 +20,27 @@ ost.helpers.scihub
       s1_download
       s1_download_parallel
 
-.. automethod:: ost.helpers.scihub.ask_credentials
+.. autofunction:: ost.helpers.scihub.ask_credentials
 
-.. automethod:: ost.helpers.scihub.batch_download
+.. autofunction:: ost.helpers.scihub.batch_download
 
-.. automethod:: ost.helpers.scihub.check_connection
+.. autofunction:: ost.helpers.scihub.check_connection
 
-.. automethod:: ost.helpers.scihub.connect
+.. autofunction:: ost.helpers.scihub.connect
 
-.. automethod:: ost.helpers.scihub.create_aoi_str
+.. autofunction:: ost.helpers.scihub.create_aoi_str
 
-.. automethod:: ost.helpers.scihub.create_s1_product_specs
+.. autofunction:: ost.helpers.scihub.create_s1_product_specs
 
-.. automethod:: ost.helpers.scihub.create_satellite_string
+.. autofunction:: ost.helpers.scihub.create_satellite_string
 
-.. automethod:: ost.helpers.scihub.create_toi_str
+.. autofunction:: ost.helpers.scihub.create_toi_str
 
-.. automethod:: ost.helpers.scihub.next_page
+.. autofunction:: ost.helpers.scihub.next_page
 
-.. automethod:: ost.helpers.scihub.s1_download
+.. autofunction:: ost.helpers.scihub.s1_download
 
-.. automethod:: ost.helpers.scihub.s1_download_parallel
+.. autofunction:: ost.helpers.scihub.s1_download_parallel
 
 
 

diff --git a/docs/source/modules/ost.helpers.settings.rst b/docs/source/modules/ost.helpers.settings.rst
@@ -16,19 +16,19 @@ ost.helpers.settings
       set_log_level
       setup_logfile
 
-.. automethod:: ost.helpers.settings.check_ard_parameters
+.. autofunction:: ost.helpers.settings.check_ard_parameters
 
-.. automethod:: ost.helpers.settings.check_value
+.. autofunction:: ost.helpers.settings.check_value
 
-.. automethod:: ost.helpers.settings.exception_handler
+.. autofunction:: ost.helpers.settings.exception_handler
 
-.. automethod:: ost.helpers.settings.generate_access_file
+.. autofunction:: ost.helpers.settings.generate_access_file
 
-.. automethod:: ost.helpers.settings.get_gpt
+.. autofunction:: ost.helpers.settings.get_gpt
 
-.. automethod:: ost.helpers.settings.set_log_level
+.. autofunction:: ost.helpers.settings.set_log_level
 
-.. automethod:: ost.helpers.settings.setup_logfile
+.. autofunction:: ost.helpers.settings.setup_logfile
 
 
 

diff --git a/docs/source/modules/ost.helpers.srtm.rst b/docs/source/modules/ost.helpers.srtm.rst
@@ -11,9 +11,9 @@ ost.helpers.srtm
       download_srtm
       download_srtm_tile
 
-.. automethod:: ost.helpers.srtm.download_srtm
+.. autofunction:: ost.helpers.srtm.download_srtm
 
-.. automethod:: ost.helpers.srtm.download_srtm_tile
+.. autofunction:: ost.helpers.srtm.download_srtm_tile