Skip to content

Commit 30b4db3

Browse files
committed
Use relative refs
1 parent 36d9f5f commit 30b4db3

17 files changed

Lines changed: 74 additions & 74 deletions

docs/src/content/docs/apis/overview.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,27 +12,27 @@ pyDataverse provides several low-level API classes that offer direct access to D
1212
<CardGrid>
1313
<LinkCard
1414
title="Native API"
15-
href="/apis/native"
15+
href="../native/"
1616
description="Primary low-level client for collections, datasets, files, and metadata operations."
1717
/>
1818
<LinkCard
1919
title="Data Access API"
20-
href="/apis/data-access"
20+
href="../data-access/"
2121
description="Specialized file retrieval, downloads, streaming, and access management."
2222
/>
2323
<LinkCard
2424
title="Semantic API"
25-
href="/apis/semantic"
25+
href="../semantic/"
2626
description="JSON-LD metadata, RDF conversion, SPARQL queries, and knowledge graphs."
2727
/>
2828
<LinkCard
2929
title="Metrics API"
30-
href="/apis/metrics"
30+
href="../metrics/"
3131
description="Usage statistics, analytics, and insights into content distribution."
3232
/>
3333
<LinkCard
3434
title="Search API"
35-
href="/apis/search"
35+
href="../search/"
3636
description="Full-text search across collections, datasets, and files with advanced filtering."
3737
/>
3838
</CardGrid>

docs/src/content/docs/filesystem/browsing.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ To avoid re-fetching the dataset's file listing on every call, `DataverseFS`
9797
caches it for `cache_ttl` seconds (default `60`). Writes through the filesystem
9898
clear this cache automatically, so newly written files appear immediately. If you
9999
change the dataset out-of-band (for example via the low-level
100-
[Native API](/apis/native/)) and want the filesystem to see it right away, call:
100+
[Native API](../../apis/native/)) and want the filesystem to see it right away, call:
101101

102102
```python
103103
fs.invalidate_cache()

docs/src/content/docs/filesystem/connecting.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ otherwise a `ValueError` is raised.
4242

4343
## From a high-level `Dataset`
4444

45-
If you are already working with the [high-level API](/high-level/dataset/), every
45+
If you are already working with the [high-level API](../../high-level/dataset/), every
4646
`Dataset` exposes a ready-to-use filesystem via its `fs` property. This reuses the
4747
dataset's existing API clients and credentials, so you don't repeat the base URL
4848
or token:
@@ -114,5 +114,5 @@ fs = fsspec.filesystem(
114114
)
115115
```
116116

117-
See [pandas & the fsspec ecosystem](/filesystem/pandas/) for the URL-based form
117+
See [pandas & the fsspec ecosystem](../pandas/) for the URL-based form
118118
that lets tools open dataset files without constructing a filesystem at all.

docs/src/content/docs/filesystem/overview.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ instance, you can browse, read, write, and delete files using the standard
1111
fsspec interface (`ls`, `info`, `open`, `cat`, `rm`, `find`, `glob`, ...) plus a
1212
few Dataverse-specific helpers for tabular data.
1313

14-
It is the same machinery that powers the high-level [`Dataset`](/high-level/dataset/)
14+
It is the same machinery that powers the high-level [`Dataset`](../../high-level/dataset/)
1515
file operations — `dataset.open(...)`, `dataset.files`, `dataset.upload_file(...)`
1616
all delegate to a `DataverseFS` under the hood — but you can also use it directly
1717
whenever you want a filesystem-style view of a dataset.
@@ -55,32 +55,32 @@ with fs.open("data/notes.txt", "r") as f: # stream a file
5555
<CardGrid>
5656
<LinkCard
5757
title="Connecting"
58-
href="/filesystem/connecting"
58+
href="../connecting/"
5959
description="Create a DataverseFS — directly, from a URL, or from a high-level Dataset."
6060
/>
6161
<LinkCard
6262
title="Browsing & metadata"
63-
href="/filesystem/browsing"
63+
href="../browsing/"
6464
description="List, glob, and inspect files; read rich Dataverse metadata."
6565
/>
6666
<LinkCard
6767
title="Reading files"
68-
href="/filesystem/reading"
68+
href="../reading/"
6969
description="Stream file content in text or binary, including byte-range reads."
7070
/>
7171
<LinkCard
7272
title="Writing files"
73-
href="/filesystem/writing"
73+
href="../writing/"
7474
description="Create, replace, and delete files; attach metadata on upload."
7575
/>
7676
<LinkCard
7777
title="Tabular data"
78-
href="/filesystem/tabular"
78+
href="../tabular/"
7979
description="Load ingested tabular files straight into pandas DataFrames."
8080
/>
8181
<LinkCard
8282
title="pandas & the fsspec ecosystem"
83-
href="/filesystem/pandas"
83+
href="../pandas/"
8484
description="Read datasets by URL from pandas, Dask, Polars, and the command line."
8585
/>
8686
</CardGrid>

docs/src/content/docs/filesystem/pandas.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ df = pd.read_csv(url, sep="\t")
5454

5555
:::tip
5656
If you'd rather not remember the delimiter, use
57-
[`fs.open_tabular(...)`](/filesystem/tabular/) instead — it detects the format
57+
[`fs.open_tabular(...)`](../tabular/) instead — it detects the format
5858
from the file's MIME type and returns a DataFrame directly.
5959
:::
6060

@@ -154,5 +154,5 @@ df.to_csv(
154154
)
155155
```
156156

157-
See [Writing files](/filesystem/writing/) for the details of how uploads stream
157+
See [Writing files](../writing/) for the details of how uploads stream
158158
and how to attach metadata.

docs/src/content/docs/filesystem/reading.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ with fs.open("data/image.png", "rb") as f:
2424
```
2525

2626
Text mode returns a handle that still exposes the underlying Dataverse file's
27-
attributes (see [Writing files](/filesystem/writing/#reading-back-the-uploaded-files-id)),
27+
attributes (see [Writing files](../writing/#reading-back-the-uploaded-files-id)),
2828
so you don't lose anything by working with text.
2929

3030
## Seeking and partial reads
@@ -80,7 +80,7 @@ fs.get("data/", "local_dir/", recursive=True)
8080
Reading an **ingested tabular** file (a `.tab` produced by Dataverse) returns the
8181
reconstructed tab-delimited text, including the header row Dataverse stores
8282
separately. If you want the data as a DataFrame rather than raw bytes, use the
83-
helpers on the [Tabular data](/filesystem/tabular/) page instead.
83+
helpers on the [Tabular data](../tabular/) page instead.
8484
:::
8585

8686
## How it works

docs/src/content/docs/filesystem/tabular.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,5 +90,5 @@ dataset (or call `fs.invalidate_cache()`) once ingest has completed.
9090

9191
Everything above goes through pyDataverse. If you'd rather hand a URL to pandas,
9292
Dask, or Polars and let them read it directly, see
93-
[pandas & the fsspec ecosystem](/filesystem/pandas/) — including a complete,
93+
[pandas & the fsspec ecosystem](../pandas/) — including a complete,
9494
runnable example against a public dataset.

docs/src/content/docs/getting-started.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,12 @@ For many use cases this pattern is all you need to get started. As you become mo
5555
<CardGrid>
5656
<LinkCard
5757
title="High-Level API"
58-
href="/high-level/concept/"
58+
href="../high-level/concept/"
5959
description="Learn about the high-level API classes for working with Dataverse installations, collections, datasets, and files."
6060
/>
6161
<LinkCard
6262
title="Direct APIs"
63-
href="/apis/overview/"
63+
href="../apis/overview/"
6464
description="Explore the low-level API classes for direct access to Dataverse REST endpoints."
6565
/>
6666
</CardGrid>

docs/src/content/docs/high-level/collection.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The identifier determines how the collection is accessed and referenced. String
3838

3939
## Accessing Collections
4040

41-
Collections are typically accessed through the [`Dataverse`](/high-level/Dataverse/) class or as sub-collections of other collections:
41+
Collections are typically accessed through the [`Dataverse`](../dataverse/) class or as sub-collections of other collections:
4242

4343
```python
4444
from pyDataverse import Dataverse
@@ -374,12 +374,12 @@ This example demonstrates the typical workflow: fetching a collection, browsing
374374

375375
## Related Classes
376376

377-
- **[`Dataverse`](/high-level/Dataverse/)** - Factory class for creating and managing collections and datasets
378-
- **[`Dataset`](/high-level/dataset/)** - Represents a Dataverse dataset that can be created within or accessed from collections
379-
- **[`File`](/high-level/file/)** - Represents an individual file within a dataset
377+
- **[`Dataverse`](../dataverse/)** - Factory class for creating and managing collections and datasets
378+
- **[`Dataset`](../dataset/)** - Represents a Dataverse dataset that can be created within or accessed from collections
379+
- **[`File`](../file/)** - Represents an individual file within a dataset
380380

381381
## See Also
382382

383-
- [Dataverse Documentation](/high-level/Dataverse/) - Learn more about creating and managing collections
384-
- [Dataset Documentation](/high-level/dataset/) - Learn more about working with datasets within collections
385-
- [File Documentation](/high-level/file/) - Learn more about working with files in datasets
383+
- [Dataverse Documentation](../dataverse/) - Learn more about creating and managing collections
384+
- [Dataset Documentation](../dataset/) - Learn more about working with datasets within collections
385+
- [File Documentation](../file/) - Learn more about working with files in datasets

docs/src/content/docs/high-level/concept.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,22 +20,22 @@ pyDataverse provides four main classes that correspond to the Dataverse hierarch
2020
<CardGrid>
2121
<LinkCard
2222
title="Dataverse"
23-
href="/high-level/dataverse/"
23+
href="../dataverse/"
2424
description="Main entry point connecting to a Dataverse installation. Factory for creating datasets and accessing collections, metrics, and API clients."
2525
/>
2626
<LinkCard
2727
title="Collection"
28-
href="/high-level/collection/"
28+
href="../collection/"
2929
description="Organizational containers that group related datasets. Support hierarchical nesting and have their own metadata and permissions."
3030
/>
3131
<LinkCard
3232
title="Dataset"
33-
href="/high-level/dataset/"
33+
href="../dataset/"
3434
description="Containers for research outputs with structured metadata blocks and files. Independently citable research objects with persistent identifiers."
3535
/>
3636
<LinkCard
3737
title="File"
38-
href="/high-level/file/"
38+
href="../file/"
3939
description="Individual research artifacts within datasets. Support reading, downloading, metadata management, and pandas integration for tabular data."
4040
/>
4141
</CardGrid>

0 commit comments

Comments
 (0)