Skip to content

Commit 631216e

Browse files
Fix links in docs
1 parent 9b1cefe commit 631216e

7 files changed

Lines changed: 9 additions & 9 deletions

File tree

‎docs/concepts/layers-and-stacks.md‎

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

33
## Data layers
44

5-
A **data layer** holds a single piece of data, such as an image, a segmentation mask, a set of points, or a numeric value, together with information about what that data means. All data layers derive from `sk.Layer`, and the available types are listed in [Data layers](../reference/layers.md).
5+
A **data layer** holds a single piece of data, such as an image, a segmentation mask, a set of points, or a numeric value, together with information about what that data means. All data layers derive from `sk.Layer`, and the available types are listed in [Data layers](../reference/api/layers.md).
66

77
Data layers play two roles:
88

‎docs/how-to/live-updates.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,4 +78,4 @@ Here, the algorithm notifies the user that processing has started, then yields a
7878
- `sk.Notification` is used to show a message to the user. In Napari, it appears as a notification. You can set its level with `level="info"` (default), `"warning"`, or `"error"`.
7979
- `sk.Progress` updates a progress bar, up to `max_val`.
8080

81-
See [Data layers](../reference/layers.md) for the other layer types.
81+
See [Data layers](../reference/api/layers.md) for the other layer types.

‎docs/how-to/tiling.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,4 +80,4 @@ def label_objects(image, threshold=128):
8080
return sk.Mask(labels, merger="instances")
8181
```
8282

83-
See [Tile merging](../concepts/coordinates.md#tile-merging) for how each layer type is assembled from tiles.
83+
See [Merging tiles](../concepts/coordinates.md#merging-tiles) for how each layer type is assembled from tiles.

‎docs/reference/api/layers.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Data layers
22

3-
See [Data layers](../layers.md) for an overview of the available layers.
3+
See [Data layers](../../concepts/layers-and-stacks.md) for an introduction to data layers.
44

55
::: imaging_server_kit.Layer
66
options:

‎docs/tutorial/create-algorithm.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ The algorithm works, but there is room for improvement. For example, nothing pre
6363

6464
## Annotating parameters
6565

66-
Annotating parameters tells *Imaging Server Kit* how to interpret the function arguments. Each parameter is matched with a [data layer](../reference/layers.md), which is used to validate its value and to display it in user interfaces.
66+
Annotating parameters tells *Imaging Server Kit* how to interpret the function arguments. Each parameter is matched with a [data layer](../reference/api/layers.md), which is used to validate its value and to display it in user interfaces.
6767

6868
Here is an improved version of the Gaussian filter, where `sigma` is annotated through `parameters={}` in the decorator, with a minimum and a default value:
6969

@@ -85,7 +85,7 @@ In Napari, `sigma` can no longer be set to a negative value.
8585
- `step` (for UI sliders and spin boxes)
8686
- `name` (the label shown next to the parameter)
8787

88-
See [Data layers](../reference/layers.md) for the full list of layers.
88+
See [Data layers](../reference/api/layers.md) for the full list of layers.
8989

9090
`parameters={}` is the most explicit annotation method, but type hints, default values, and even variable names also work. All the following are valid:
9191

@@ -106,7 +106,7 @@ def gaussian_algo(img: sk.Image, sigma: float):
106106
...
107107
```
108108

109-
When several methods apply to the same parameter, explicit annotations take priority. See [Parameter resolution](../concepts/algorithms.md#parameter-resolution) for a full review of the rules.
109+
When several methods apply to the same parameter, explicit annotations take priority. See [Matching parameters with data layers](../concepts/algorithms.md#matching-parameters-with-data-layers) for a full review of the rules.
110110

111111
## Annotating return values
112112

‎mkdocs.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ extra:
140140
sections/06_tiled.html: how-to/tiling.md
141141
sections/07_server.html: tutorial/serve.md
142142
sections/08_python.html: tutorial/python.md
143-
sections/09_layers.html: reference/layers.md
143+
sections/09_layers.html: reference/api/layers.md
144144
sections/10_examples.html: examples.md
145145
sections/11_qupath.html: how-to/qupath.md
146146

‎src/imaging_server_kit/merge/layer_merger.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ def merge_layers(layers: List[Layer]) -> Layer:
7777
"""Merge a list of data layers of the same kind into a new layer.
7878
7979
The layers are merged as successive tiles, following the merging strategy of the
80-
layer type (see the "Tile merging" section of the documentation). The input layers
80+
layer type (see the "Merging tiles" section of the documentation). The input layers
8181
are not modified.
8282
8383
Parameters

0 commit comments

Comments
 (0)