Skip to content

Commit f2ab0b5

Browse files
12rambau12rambau
authored
Merge pull request #78 from ESA-PhiLab/autodoc
avoid skipping of first argument in module functions
2 parents b8d0f59 + ba274f7 commit f2ab0b5

31 files changed

+155
-155
lines changed

‎.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -131,3 +131,6 @@ dmypy.json
131131

132132
# macOS
133133
.DS_Store
134+
135+
# IDE
136+
.vscode

‎.vscode/settings.json

-3
This file was deleted.

‎docs/source/modules/ost.generic.ard_to_ts.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ ost.generic.ard\_to\_ts
1111
ard_to_ts
1212
gd_ard_to_ts
1313

14-
.. automethod:: ost.generic.ard_to_ts.ard_to_ts
14+
.. autofunction:: ost.generic.ard_to_ts.ard_to_ts
1515

16-
.. automethod:: ost.generic.ard_to_ts.gd_ard_to_ts
16+
.. autofunction:: ost.generic.ard_to_ts.gd_ard_to_ts
1717

1818

1919

‎docs/source/modules/ost.generic.common_wrappers.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,19 @@ ost.generic.common\_wrappers
1616
terrain_correction
1717
terrain_flattening
1818

19-
.. automethod:: ost.generic.common_wrappers.create_stack
19+
.. autofunction:: ost.generic.common_wrappers.create_stack
2020

21-
.. automethod:: ost.generic.common_wrappers.linear_to_db
21+
.. autofunction:: ost.generic.common_wrappers.linear_to_db
2222

23-
.. automethod:: ost.generic.common_wrappers.ls_mask
23+
.. autofunction:: ost.generic.common_wrappers.ls_mask
2424

25-
.. automethod:: ost.generic.common_wrappers.mt_speckle_filter
25+
.. autofunction:: ost.generic.common_wrappers.mt_speckle_filter
2626

27-
.. automethod:: ost.generic.common_wrappers.speckle_filter
27+
.. autofunction:: ost.generic.common_wrappers.speckle_filter
2828

29-
.. automethod:: ost.generic.common_wrappers.terrain_correction
29+
.. autofunction:: ost.generic.common_wrappers.terrain_correction
3030

31-
.. automethod:: ost.generic.common_wrappers.terrain_flattening
31+
.. autofunction:: ost.generic.common_wrappers.terrain_flattening
3232

3333

3434

‎docs/source/modules/ost.generic.mosaic.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@ ost.generic.mosaic
1414
mosaic
1515
mosaic_slc_acquisition
1616

17-
.. automethod:: ost.generic.mosaic.create_timeseries_mosaic_vrt
17+
.. autofunction:: ost.generic.mosaic.create_timeseries_mosaic_vrt
1818

19-
.. automethod:: ost.generic.mosaic.gd_mosaic
19+
.. autofunction:: ost.generic.mosaic.gd_mosaic
2020

21-
.. automethod:: ost.generic.mosaic.gd_mosaic_slc_acquisition
21+
.. autofunction:: ost.generic.mosaic.gd_mosaic_slc_acquisition
2222

23-
.. automethod:: ost.generic.mosaic.mosaic
23+
.. autofunction:: ost.generic.mosaic.mosaic
2424

25-
.. automethod:: ost.generic.mosaic.mosaic_slc_acquisition
25+
.. autofunction:: ost.generic.mosaic.mosaic_slc_acquisition
2626

2727

2828

‎docs/source/modules/ost.generic.timescan.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,19 @@ ost.generic.timescan
1616
nan_percentile
1717
remove_outliers
1818

19-
.. automethod:: ost.generic.timescan.date_as_float
19+
.. autofunction:: ost.generic.timescan.date_as_float
2020

21-
.. automethod:: ost.generic.timescan.deseasonalize
21+
.. autofunction:: ost.generic.timescan.deseasonalize
2222

23-
.. automethod:: ost.generic.timescan.difference_in_years
23+
.. autofunction:: ost.generic.timescan.difference_in_years
2424

25-
.. automethod:: ost.generic.timescan.gd_mt_metrics
25+
.. autofunction:: ost.generic.timescan.gd_mt_metrics
2626

27-
.. automethod:: ost.generic.timescan.mt_metrics
27+
.. autofunction:: ost.generic.timescan.mt_metrics
2828

29-
.. automethod:: ost.generic.timescan.nan_percentile
29+
.. autofunction:: ost.generic.timescan.nan_percentile
3030

31-
.. automethod:: ost.generic.timescan.remove_outliers
31+
.. autofunction:: ost.generic.timescan.remove_outliers
3232

3333

3434

‎docs/source/modules/ost.generic.ts_extent.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ost.generic.ts\_extent
1010

1111
mt_extent
1212

13-
.. automethod:: ost.generic.ts_extent.mt_extent
13+
.. autofunction:: ost.generic.ts_extent.mt_extent
1414

1515

1616

‎docs/source/modules/ost.generic.ts_ls_mask.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ ost.generic.ts\_ls\_mask
1010

1111
mt_layover
1212

13-
.. automethod:: ost.generic.ts_ls_mask.mt_layover
13+
.. autofunction:: ost.generic.ts_ls_mask.mt_layover

‎docs/source/modules/ost.helpers.asf.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@ ost.helpers.asf
1414
batch_download
1515
check_connection
1616

17-
.. automethod:: ost.helpers.asf.asf_download
17+
.. autofunction:: ost.helpers.asf.asf_download
1818

19-
.. automethod:: ost.helpers.asf.asf_download_parallel
19+
.. autofunction:: ost.helpers.asf.asf_download_parallel
2020

21-
.. automethod:: ost.helpers.asf.ask_credentials
21+
.. autofunction:: ost.helpers.asf.ask_credentials
2222

23-
.. automethod:: ost.helpers.asf.batch_download
23+
.. autofunction:: ost.helpers.asf.batch_download
2424

25-
.. automethod:: ost.helpers.asf.check_connection
25+
.. autofunction:: ost.helpers.asf.check_connection
2626

2727

2828

‎docs/source/modules/ost.helpers.asf_wget.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ ost.helpers.asf\_wget
2020

2121
SessionWithHeaderRedirection
2222

23-
.. automethod:: ost.helpers.asf_wget.batch_download
23+
.. autofunction:: ost.helpers.asf_wget.batch_download
2424

25-
.. automethod:: ost.helpers.asf_wget.check_connection
25+
.. autofunction:: ost.helpers.asf_wget.check_connection
2626

27-
.. automethod:: ost.helpers.asf_wget.s1_download
27+
.. autofunction:: ost.helpers.asf_wget.s1_download
2828

2929

3030

‎docs/source/modules/ost.helpers.db.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ ost.helpers.db
1818

1919
pgConnect
2020

21-
.. automethod:: ost.helpers.db.pgHandler
21+
.. autofunction:: ost.helpers.db.pgHandler
2222

2323

2424

‎docs/source/modules/ost.helpers.errors.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ ost.helpers.errors
1212
GPTRuntimeError
1313
NotValidFileError
1414

15-
.. automethod:: ost.helpers.errors.DownloadError
15+
.. autofunction:: ost.helpers.errors.DownloadError
1616

17-
.. automethod:: ost.helpers.errors.GPTRuntimeError
17+
.. autofunction:: ost.helpers.errors.GPTRuntimeError
1818

19-
.. automethod:: ost.helpers.errors.NotValidFileError
19+
.. autofunction:: ost.helpers.errors.NotValidFileError
2020

2121

2222

‎docs/source/modules/ost.helpers.helpers.rst

+10-10
Original file line numberDiff line numberDiff line change
@@ -19,25 +19,25 @@ ost.helpers.helpers
1919
run_command
2020
timer
2121

22-
.. automethod:: ost.helpers.helpers.check_out_dimap
22+
.. autofunction:: ost.helpers.helpers.check_out_dimap
2323

24-
.. automethod:: ost.helpers.helpers.check_out_tiff
24+
.. autofunction:: ost.helpers.helpers.check_out_tiff
2525

26-
.. automethod:: ost.helpers.helpers.check_zipfile
26+
.. autofunction:: ost.helpers.helpers.check_zipfile
2727

28-
.. automethod:: ost.helpers.helpers.delete_dimap
28+
.. autofunction:: ost.helpers.helpers.delete_dimap
2929

30-
.. automethod:: ost.helpers.helpers.delete_shapefile
30+
.. autofunction:: ost.helpers.helpers.delete_shapefile
3131

32-
.. automethod:: ost.helpers.helpers.move_dimap
32+
.. autofunction:: ost.helpers.helpers.move_dimap
3333

34-
.. automethod:: ost.helpers.helpers.remove_folder_content
34+
.. autofunction:: ost.helpers.helpers.remove_folder_content
3535

36-
.. automethod:: ost.helpers.helpers.resolution_in_degree
36+
.. autofunction:: ost.helpers.helpers.resolution_in_degree
3737

38-
.. automethod:: ost.helpers.helpers.run_command
38+
.. autofunction:: ost.helpers.helpers.run_command
3939

40-
.. automethod:: ost.helpers.helpers.timer
40+
.. autofunction:: ost.helpers.helpers.timer
4141

4242

4343

‎docs/source/modules/ost.helpers.onda.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@ ost.helpers.onda
1414
connect
1515
onda_download
1616

17-
.. automethod:: ost.helpers.onda.ask_credentials
17+
.. autofunction:: ost.helpers.onda.ask_credentials
1818

19-
.. automethod:: ost.helpers.onda.batch_download
19+
.. autofunction:: ost.helpers.onda.batch_download
2020

21-
.. automethod:: ost.helpers.onda.check_connection
21+
.. autofunction:: ost.helpers.onda.check_connection
2222

23-
.. automethod:: ost.helpers.onda.connect
23+
.. autofunction:: ost.helpers.onda.connect
2424

25-
.. automethod:: ost.helpers.onda.onda_download
25+
.. autofunction:: ost.helpers.onda.onda_download
2626

2727

2828

‎docs/source/modules/ost.helpers.peps.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@ ost.helpers.peps
1414
connect
1515
peps_download
1616

17-
.. automethod:: ost.helpers.peps.ask_credentials
17+
.. autofunction:: ost.helpers.peps.ask_credentials
1818

19-
.. automethod:: ost.helpers.peps.batch_download
19+
.. autofunction:: ost.helpers.peps.batch_download
2020

21-
.. automethod:: ost.helpers.peps.check_connection
21+
.. autofunction:: ost.helpers.peps.check_connection
2222

23-
.. automethod:: ost.helpers.peps.connect
23+
.. autofunction:: ost.helpers.peps.connect
2424

25-
.. automethod:: ost.helpers.peps.peps_download
25+
.. autofunction:: ost.helpers.peps.peps_download
2626

2727

2828

‎docs/source/modules/ost.helpers.raster.rst

+20-20
Original file line numberDiff line numberDiff line change
@@ -29,45 +29,45 @@ ost.helpers.raster
2929
stretch_to_8bit
3030
visualise_rgb
3131

32-
.. automethod:: ost.helpers.raster.calc_max
32+
.. autofunction:: ost.helpers.raster.calc_max
3333

34-
.. automethod:: ost.helpers.raster.calc_min
34+
.. autofunction:: ost.helpers.raster.calc_min
3535

36-
.. automethod:: ost.helpers.raster.combine_timeseries
36+
.. autofunction:: ost.helpers.raster.combine_timeseries
3737

38-
.. automethod:: ost.helpers.raster.convert_to_db
38+
.. autofunction:: ost.helpers.raster.convert_to_db
3939

40-
.. automethod:: ost.helpers.raster.create_rgb_jpeg
40+
.. autofunction:: ost.helpers.raster.create_rgb_jpeg
4141

42-
.. automethod:: ost.helpers.raster.create_timeseries_animation
42+
.. autofunction:: ost.helpers.raster.create_timeseries_animation
4343

44-
.. automethod:: ost.helpers.raster.create_tscan_vrt
44+
.. autofunction:: ost.helpers.raster.create_tscan_vrt
4545

46-
.. automethod:: ost.helpers.raster.fill_internal_nans
46+
.. autofunction:: ost.helpers.raster.fill_internal_nans
4747

48-
.. automethod:: ost.helpers.raster.get_max
48+
.. autofunction:: ost.helpers.raster.get_max
4949

50-
.. automethod:: ost.helpers.raster.get_min
50+
.. autofunction:: ost.helpers.raster.get_min
5151

52-
.. automethod:: ost.helpers.raster.image_bounds
52+
.. autofunction:: ost.helpers.raster.image_bounds
5353

54-
.. automethod:: ost.helpers.raster.mask_by_shape
54+
.. autofunction:: ost.helpers.raster.mask_by_shape
5555

56-
.. automethod:: ost.helpers.raster.norm
56+
.. autofunction:: ost.helpers.raster.norm
5757

58-
.. automethod:: ost.helpers.raster.outline
58+
.. autofunction:: ost.helpers.raster.outline
5959

60-
.. automethod:: ost.helpers.raster.polygonize_bounds
60+
.. autofunction:: ost.helpers.raster.polygonize_bounds
6161

62-
.. automethod:: ost.helpers.raster.polygonize_ls
62+
.. autofunction:: ost.helpers.raster.polygonize_ls
6363

64-
.. automethod:: ost.helpers.raster.rescale_to_float
64+
.. autofunction:: ost.helpers.raster.rescale_to_float
6565

66-
.. automethod:: ost.helpers.raster.scale_to_int
66+
.. autofunction:: ost.helpers.raster.scale_to_int
6767

68-
.. automethod:: ost.helpers.raster.stretch_to_8bit
68+
.. autofunction:: ost.helpers.raster.stretch_to_8bit
6969

70-
.. automethod:: ost.helpers.raster.visualise_rgb
70+
.. autofunction:: ost.helpers.raster.visualise_rgb
7171

7272

7373

‎docs/source/modules/ost.helpers.scihub.rst

+11-11
Original file line numberDiff line numberDiff line change
@@ -20,27 +20,27 @@ ost.helpers.scihub
2020
s1_download
2121
s1_download_parallel
2222

23-
.. automethod:: ost.helpers.scihub.ask_credentials
23+
.. autofunction:: ost.helpers.scihub.ask_credentials
2424

25-
.. automethod:: ost.helpers.scihub.batch_download
25+
.. autofunction:: ost.helpers.scihub.batch_download
2626

27-
.. automethod:: ost.helpers.scihub.check_connection
27+
.. autofunction:: ost.helpers.scihub.check_connection
2828

29-
.. automethod:: ost.helpers.scihub.connect
29+
.. autofunction:: ost.helpers.scihub.connect
3030

31-
.. automethod:: ost.helpers.scihub.create_aoi_str
31+
.. autofunction:: ost.helpers.scihub.create_aoi_str
3232

33-
.. automethod:: ost.helpers.scihub.create_s1_product_specs
33+
.. autofunction:: ost.helpers.scihub.create_s1_product_specs
3434

35-
.. automethod:: ost.helpers.scihub.create_satellite_string
35+
.. autofunction:: ost.helpers.scihub.create_satellite_string
3636

37-
.. automethod:: ost.helpers.scihub.create_toi_str
37+
.. autofunction:: ost.helpers.scihub.create_toi_str
3838

39-
.. automethod:: ost.helpers.scihub.next_page
39+
.. autofunction:: ost.helpers.scihub.next_page
4040

41-
.. automethod:: ost.helpers.scihub.s1_download
41+
.. autofunction:: ost.helpers.scihub.s1_download
4242

43-
.. automethod:: ost.helpers.scihub.s1_download_parallel
43+
.. autofunction:: ost.helpers.scihub.s1_download_parallel
4444

4545

4646

‎docs/source/modules/ost.helpers.settings.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,19 @@ ost.helpers.settings
1616
set_log_level
1717
setup_logfile
1818

19-
.. automethod:: ost.helpers.settings.check_ard_parameters
19+
.. autofunction:: ost.helpers.settings.check_ard_parameters
2020

21-
.. automethod:: ost.helpers.settings.check_value
21+
.. autofunction:: ost.helpers.settings.check_value
2222

23-
.. automethod:: ost.helpers.settings.exception_handler
23+
.. autofunction:: ost.helpers.settings.exception_handler
2424

25-
.. automethod:: ost.helpers.settings.generate_access_file
25+
.. autofunction:: ost.helpers.settings.generate_access_file
2626

27-
.. automethod:: ost.helpers.settings.get_gpt
27+
.. autofunction:: ost.helpers.settings.get_gpt
2828

29-
.. automethod:: ost.helpers.settings.set_log_level
29+
.. autofunction:: ost.helpers.settings.set_log_level
3030

31-
.. automethod:: ost.helpers.settings.setup_logfile
31+
.. autofunction:: ost.helpers.settings.setup_logfile
3232

3333

3434

‎docs/source/modules/ost.helpers.srtm.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ ost.helpers.srtm
1111
download_srtm
1212
download_srtm_tile
1313

14-
.. automethod:: ost.helpers.srtm.download_srtm
14+
.. autofunction:: ost.helpers.srtm.download_srtm
1515

16-
.. automethod:: ost.helpers.srtm.download_srtm_tile
16+
.. autofunction:: ost.helpers.srtm.download_srtm_tile
1717

1818

1919

0 commit comments

Comments
 (0)