Skip to content

Commit 0236051

Browse files
committed
make links mkdocs style
1 parent 4788098 commit 0236051

File tree

2 files changed

+11
-14
lines changed

2 files changed

+11
-14
lines changed

docs/user-guide/storage.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@ Zarr-Python 3, stores must implement the abstract store API from
1111

1212
## Implicit Store Creation
1313

14-
In most cases, it is not required to create a `Store` object explicitly. Passing a string (or other StoreLike value LINK)
15-
to Zarr's top level API will result in the store being created automatically:
14+
In most cases, it is not required to create a `Store` object explicitly. Passing a string
15+
(or other [StoreLike value](#storelike)) to Zarr's top level API will result in the store
16+
being created automatically:
1617

1718
```python exec="true" session="storage" source="above" result="ansi"
1819
import zarr
@@ -43,21 +44,18 @@ print(group)
4344

4445
`StoreLike` values can be:
4546

46-
- a `Path` or string indicating a :ref:`local store <user-guide-local-store>` location e.g.:
47-
47+
- a `Path` or string indicating a [local store](#local-store) location e.g.:
4848
```python exec="true" session="storage" source="above" result="ansi"
4949
group = zarr.open_group(store='data/foo/bar')
5050
print(group)
5151
```
52-
5352
```python exec="true" session="storage" source="above" result="ansi"
5453
from pathlib import Path
5554
group = zarr.open_group(store=Path('data/foo/bar'))
5655
print(group)
5756
```
5857

59-
- an FSSpec URI string, indicating a :ref:`remote store <user-guide-remote-store>` location e.g.:
60-
58+
- an FSSpec URI string, indicating a [remote store](#remote-store) location e.g.:
6159
```python exec="true" session="storage" source="above" result="ansi"
6260
group = zarr.open_group(
6361
store='s3://noaa-nwm-retro-v2-zarr-pds',
@@ -67,8 +65,7 @@ print(group)
6765
print(group)
6866
```
6967

70-
- an empty dictionary or None, which will create a new :ref:`memory store <user-guide-memory-store>`:
71-
68+
- an empty dictionary or None, which will create a new [memory store](#memory-store):
7269
```python exec="true" session="storage" source="above" result="ansi"
7370
group = zarr.create_group(store={})
7471
print(group)
@@ -78,13 +75,13 @@ print(group)
7875
print(group)
7976
```
8077

81-
- a dictionary of string to :class:`Buffer <zarr.abc.buffer.Buffer>` mappings, which
82-
will create a :ref:`memory store <user-guide-memory-store>`.
78+
- a dictionary of string to [`Buffer`][zarr.abc.buffer.Buffer] mappings, which
79+
will create a [memory store](#memory-store).
8380

8481
- an FSSpec [FSMap object](https://filesystem-spec.readthedocs.io/en/latest/api.html#fsspec.FSMap),
85-
which will create an :ref:`FsspecStore <user-guide-remote-store>`.
82+
which will create an [FsspecStore](#remote-store).
8683

87-
- a :class:`Store <zarr.abc.store.Store>` or :class:`StorePath <zarr.storage.StorePath>` -
84+
- a [`Store`][zarr.abc.store.Store] or [`StorePath`][zarr.storage.StorePath] -
8885
see explicit store creation below.
8986

9087
## Explicit Store Creation

src/zarr/api/synchronous.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ def open(
183183
Parameters
184184
----------
185185
store : StoreLike or None, default=None
186-
See the :ref:`storage documentation in the user guide <user-guide-storelike>`
186+
See the [`storage documentation in the user guide`][storelike]
187187
for a description of all valid StoreLike values.
188188
mode : {'r', 'r+', 'a', 'w', 'w-'}, optional
189189
Persistence mode: 'r' means read only (must exist); 'r+' means

0 commit comments

Comments
 (0)