Skip to content

Commit 39648e4

Browse files
authored
docs: use clean module-based API URLs (#1089)
* docs: use module-based API URLs * docs: update earth2studio-gallery pin
1 parent ecc8362 commit 39648e4

8 files changed

Lines changed: 39 additions & 30 deletions

File tree

docs/modules/datasources_analysis.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Used for fetching initial conditions for inference and validation data for scori
1616
## Available Data Sources
1717

1818
<!-- e2s-autosummary
19-
currentmodule: earth2studio
19+
currentmodule: earth2studio.data
2020
template: datasource
2121
output: generated/data/analysis
2222
-->
@@ -70,7 +70,7 @@ earth2studio.data.DataArrayPathList
7070
## AI Data Sources
7171

7272
<!-- e2s-autosummary
73-
currentmodule: earth2studio
73+
currentmodule: earth2studio.data
7474
template: diagnostic
7575
output: generated/data/analysis
7676
-->

docs/modules/datasources_dataframe.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
Data sources that provide tabular data as DataFrames.
88

99
<!-- e2s-autosummary
10-
currentmodule: earth2studio
10+
currentmodule: earth2studio.data
1111
template: datasource
1212
output: generated/data/dataframe
1313
-->

docs/modules/datasources_forecast.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ interchangeable with standard data sources.
99
Typically used in intercomparison workflows.
1010

1111
<!-- e2s-autosummary
12-
currentmodule: earth2studio
12+
currentmodule: earth2studio.data
1313
template: datasource
1414
output: generated/data/forecast
1515
-->

docs/modules/io.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
IO Backends for saving your inference results for further post processing.
66

77
<!-- e2s-autosummary
8-
currentmodule: earth2studio
8+
currentmodule: earth2studio.io
99
template: io
10-
output: generated/io/1
10+
output: generated/io
1111
-->
1212

1313
{% autosummary %}

docs/modules/perturbation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ with some random noise. This is commonly done to perturb initial state fields wh
77
creating ensemble forecasts.
88

99
<!-- e2s-autosummary
10-
currentmodule: earth2studio
10+
currentmodule: earth2studio.perturbation
1111
template: perturbation
12-
output: generated/perturbation/1
12+
output: generated/perturbation
1313
-->
1414

1515
{% autosummary %}

docs/modules/statistics.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
Various statistic and metric calculations for analysing inference data.
66

77
<!-- e2s-autosummary
8-
currentmodule: earth2studio
8+
currentmodule: earth2studio.statistics
99
template: statistics
10-
output: generated/statistics/1
10+
output: generated/statistics
1111
-->
1212

1313
{% autosummary %}
@@ -29,9 +29,9 @@ earth2studio.statistics.variance
2929
## Utilities
3030

3131
<!-- e2s-autosummary
32-
currentmodule: earth2studio
32+
currentmodule: earth2studio.statistics.weights
3333
template: function
34-
output: generated/statistics/2
34+
output: generated/statistics/weights
3535
-->
3636

3737
{% autosummary %}

docs/modules/utils_all.md

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
A collection of utilities to manipulate and check coordinate systems dictionaries.
66

77
<!-- e2s-autosummary
8-
currentmodule: earth2studio
8+
currentmodule: earth2studio.utils.coords
99
template: function
10-
output: generated/utils/1
10+
output: generated/utils/coords
1111
-->
1212

1313
{% autosummary %}
@@ -21,9 +21,9 @@ earth2studio.utils.coords.split_coords
2121
## Grid Interpolation
2222

2323
<!-- e2s-autosummary
24-
currentmodule: earth2studio
24+
currentmodule: earth2studio.utils.interp
2525
template: class
26-
output: generated/utils/2
26+
output: generated/utils/interp
2727
-->
2828

2929
{% autosummary %}
@@ -33,9 +33,9 @@ earth2studio.utils.interp.LatLonInterpolation
3333
## Observation Utilities
3434

3535
<!-- e2s-autosummary
36-
currentmodule: earth2studio
36+
currentmodule: earth2studio.utils.obs
3737
template: class
38-
output: generated/utils/3
38+
output: generated/utils/obs
3939
-->
4040

4141
{% autosummary %}
@@ -45,9 +45,9 @@ earth2studio.utils.obs.ObsGridMapping
4545
## Time Utilities
4646

4747
<!-- e2s-autosummary
48-
currentmodule: earth2studio
48+
currentmodule: earth2studio.utils.time
4949
template: function
50-
output: generated/utils/4
50+
output: generated/utils/time
5151
-->
5252

5353
{% autosummary %}
@@ -58,9 +58,9 @@ earth2studio.utils.time.to_time_array
5858
## Checkpoint Classes
5959

6060
<!-- e2s-autosummary
61-
currentmodule: earth2studio
61+
currentmodule: earth2studio.utils.checkpoint
6262
template: class
63-
output: generated/utils/5
63+
output: generated/utils/checkpoint
6464
-->
6565

6666
{% autosummary %}
@@ -73,9 +73,9 @@ earth2studio.utils.checkpoint.NullCheckpoint
7373
## Checkpoint Helpers
7474

7575
<!-- e2s-autosummary
76-
currentmodule: earth2studio
76+
currentmodule: earth2studio.utils.checkpoint
7777
template: function
78-
output: generated/utils/6
78+
output: generated/utils/checkpoint
7979
-->
8080

8181
{% autosummary %}
@@ -85,9 +85,9 @@ earth2studio.utils.checkpoint.bind_checkpoint_state
8585
## Data Utilities
8686

8787
<!-- e2s-autosummary
88-
currentmodule: earth2studio
88+
currentmodule: earth2studio.data
8989
template: function
90-
output: generated/utils/7
90+
output: generated/data
9191
-->
9292

9393
{% autosummary %}
@@ -99,12 +99,21 @@ earth2studio.data.prep_data_array
9999
## Model Utilities
100100

101101
<!-- e2s-autosummary
102-
currentmodule: earth2studio.models
102+
currentmodule: earth2studio.models.auto
103103
template: class
104-
output: generated/utils/8
104+
output: generated/models/auto
105105
-->
106106

107107
{% autosummary %}
108108
earth2studio.models.auto.Package
109+
{% endautosummary %}
110+
111+
<!-- e2s-autosummary
112+
currentmodule: earth2studio.models.batch
113+
template: function
114+
output: generated/models/batch
115+
-->
116+
117+
{% autosummary %}
109118
earth2studio.models.batch.batch_func
110119
{% endautosummary %}

docs/modules/workflows.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ use cases.
1111
these are starting points.
1212

1313
<!-- e2s-autosummary
14-
currentmodule: earth2studio
14+
currentmodule: earth2studio.run
1515
template: function
16-
output: generated/workflows/1
16+
output: generated/workflows
1717
-->
1818

1919
{% autosummary %}

0 commit comments

Comments
 (0)