Skip to content

Commit ba274f7

Browse files
committed
docs: use autofunction instead of automodule
1 parent e7a3178 commit ba274f7

29 files changed

+152
-152
lines changed

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

Lines changed: 2 additions & 2 deletions
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

Lines changed: 7 additions & 7 deletions
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

Lines changed: 5 additions & 5 deletions
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

Lines changed: 7 additions & 7 deletions
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 5 additions & 5 deletions
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

Lines changed: 3 additions & 3 deletions
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 3 additions & 3 deletions
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

0 commit comments

Comments
 (0)