Skip to content

Commit b3b416e

Browse files
S-HolsteinS-Holstein
committed
Changed references-documentation page from project- to module-level
1 parent e74fa8b commit b3b416e

File tree

25 files changed

+149
-121
lines changed

25 files changed

+149
-121
lines changed

‎.gitignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,5 @@
77
venv
88
dist
99
.idea
10-
.vscode
10+
.vscode
11+
.pre-commit-config.yaml

docs/design/common-library/api/reference.md renamed to docs/design/common-library/api/base.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Reference
2-
::: lib.lib
1+
# Base
2+
::: lib.lib.base
33
options:
44
show_submodules: true

‎docs/design/common-library/api/datasets.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Datasets
2+
::: lib.lib.datasets
3+
options:
4+
show_submodules: true

‎docs/design/common-library/api/providers.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Providers
2+
::: lib.lib.providers
3+
options:
4+
show_submodules: true

‎docs/design/common-library/api/resources.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Resources
2+
::: lib.lib.resources
3+
options:
4+
show_submodules: true

‎lib/lib/base/download.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
def access_token():
99
"""
10-
Description...
10+
Description...
1111
1212
Returns:
1313
(str): ...

‎lib/lib/base/file.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ def untar_file(tar_file, remove_tar=True, create_folder=False, base_folder=None)
150150

151151
def check_file_size(expected_file_size, file_path):
152152
"""
153-
Description...
153+
Description...
154154
155155
Parameters:
156156
expected_file_size: x
@@ -175,7 +175,7 @@ def check_file_size(expected_file_size, file_path):
175175

176176
def get_file_size(file_path):
177177
"""
178-
Description...
178+
Description...
179179
180180
Parameters:
181181
file_path: x
@@ -194,7 +194,7 @@ def get_file_size(file_path):
194194

195195
def get_folder_size(folder_path):
196196
"""
197-
Description...
197+
Description...
198198
199199
Parameters:
200200
folder_path: x
@@ -218,7 +218,7 @@ def get_folder_size(folder_path):
218218

219219
def calculate_checksum(algorithm, check_file):
220220
"""
221-
Description...
221+
Description...
222222
223223
Parameters:
224224
algorithm: x
@@ -238,7 +238,7 @@ def calculate_checksum(algorithm, check_file):
238238

239239
def delete_file(file: str):
240240
"""
241-
Description...
241+
Description...
242242
243243
Parameters:
244244
algorithm: x

‎lib/lib/base/geometry.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
def wkt_to_geom(wkt):
55
"""
6-
Description...
6+
Description...
77
88
Parameters:
99
wkt: x
@@ -16,7 +16,7 @@ def wkt_to_geom(wkt):
1616

1717
def geom_to_wkt(geom):
1818
"""
19-
Description...
19+
Description...
2020
2121
Parameters:
2222
geom: x
@@ -29,7 +29,7 @@ def geom_to_wkt(geom):
2929

3030
def calculate_bbox(geom):
3131
"""
32-
Description...
32+
Description...
3333
3434
Parameters:
3535
geom: x

‎lib/lib/base/geoparquet.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
def get_max_datetime_from_geoparquet(geoparquet, column):
55
"""
6-
Description...
6+
Description...
77
88
Parameters:
99
geoparquet: x

‎lib/lib/base/inventory.py‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
def update_inventory(scene_id, collection, inventory_dsn):
1111
"""
12-
Description...
12+
Description...
1313
1414
Parameters:
1515
scene_id: x
@@ -52,7 +52,7 @@ def update_inventory(scene_id, collection, inventory_dsn):
5252

5353
def get_scene_id_from_inventory_db(conn, collection, max_datetime=None):
5454
"""
55-
Description...
55+
Description...
5656
5757
Parameters:
5858
conn: x
@@ -85,7 +85,7 @@ def get_scene_id_from_inventory_db(conn, collection, max_datetime=None):
8585

8686
def get_scenes_from_inventory_file(db_file, date_column="ContentDate:Start", max_datetime=None):
8787
"""
88-
Description...
88+
Description...
8989
9090
Parameters:
9191
db_file: x
@@ -113,7 +113,7 @@ def get_scenes_from_inventory_file(db_file, date_column="ContentDate:Start", max
113113

114114
def get_scenes_diff(scenes_inventory, scenes_db, id_column):
115115
"""
116-
Description...
116+
Description...
117117
118118
Parameters:
119119
scenes_inventory: x
@@ -142,7 +142,7 @@ def get_scenes_diff(scenes_inventory, scenes_db, id_column):
142142

143143
def get_item_from_id(scene_id, collection, api_url="https://stac.terrabyte.lrz.de/inventory/api"):
144144
"""
145-
Description...
145+
Description...
146146
147147
Parameters:
148148
scene_id: x
@@ -170,7 +170,7 @@ def query_geoparquet(
170170
id_column="id",
171171
):
172172
"""
173-
Description...
173+
Description...
174174
175175
Parameters:
176176
inventory: x
@@ -229,7 +229,7 @@ def query_geoparquet(
229229

230230
def query_stac_db(cur, inventory, collection, max_datetime=None):
231231
"""
232-
Description...
232+
Description...
233233
234234
Parameters:
235235
cur: x
@@ -272,7 +272,7 @@ def query_stac_db(cur, inventory, collection, max_datetime=None):
272272

273273
def query_inventory_db(cur, inventory, collection, max_datetime=None):
274274
"""
275-
Description...
275+
Description...
276276
277277
Parameters:
278278
cur: x
@@ -328,7 +328,7 @@ def query_inventory_db(cur, inventory, collection, max_datetime=None):
328328

329329
def calculate_differences(collection, inventory_geoparquet, conn, id_column, date_column, max_datetime=None):
330330
"""
331-
Description...
331+
Description...
332332
333333
Parameters:
334334
collection: x
@@ -361,7 +361,7 @@ def calculate_differences(collection, inventory_geoparquet, conn, id_column, dat
361361

362362
def generate_stac_new_scenes(scenes, collection, inventory_fct):
363363
"""
364-
Description...
364+
Description...
365365
366366
Parameters:
367367
scenes: x
@@ -385,7 +385,7 @@ def generate_stac_new_scenes(scenes, collection, inventory_fct):
385385

386386
def import_new_scenes(scenes, collection, inventory_fct, dsn):
387387
"""
388-
Description...
388+
Description...
389389
390390
Parameters:
391391
scenes: x
@@ -402,7 +402,7 @@ def import_new_scenes(scenes, collection, inventory_fct, dsn):
402402

403403
def delete_removed_scenes(collection, to_be_removed, reasons, api_url, api_user, api_pw):
404404
"""
405-
Description...
405+
Description...
406406
407407
Parameters:
408408
collection: x

0 commit comments

Comments
 (0)