Skip to content

Commit 9b28a49

Browse files
timsaucerclaude
andcommitted
docs: fix unrecognized relative links across user guide and ffi page
Replace trailing-slash URL-style links left over from the Sphinx site with explicit `.md` paths so mkdocs can resolve and validate them. Also point the DataFusion 52 upgrade-guide reference at the FFI contributor page (the bare `[ffi](ffi)` link no longer pointed anywhere). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 28874fe commit 9b28a49

7 files changed

Lines changed: 13 additions & 13 deletions

File tree

docs/source/contributor-guide/ffi.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ when doing these integrations and the approach our project uses.
2828
## The Primary Issue
2929

3030
Suppose you wish to use DataFusion and you have a custom data source that can produce tables that
31-
can then be queried against, similar to how you can register a [CSV](../../user-guide/io/csv/) or
32-
[Parquet](../../user-guide/io/parquet/) file. In DataFusion terminology, you likely want to implement a
33-
[Custom Table Provider](../../user-guide/io/table_provider/). In an effort to make your data source
31+
can then be queried against, similar to how you can register a [CSV](../user-guide/io/csv.md) or
32+
[Parquet](../user-guide/io/parquet.md) file. In DataFusion terminology, you likely want to implement a
33+
[Custom Table Provider](../user-guide/io/table_provider.md). In an effort to make your data source
3434
as performant as possible and to utilize the features of DataFusion, you may decide to write
3535
your source in Rust and then expose it through [PyO3](https://pyo3.rs) as a Python library.
3636

docs/source/user-guide/common-operations/windows.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ print(df.select(
6565
### Partitions
6666

6767
A window function can take a list of `partition_by` columns similar to an
68-
[Aggregation Function](../aggregations/). This will cause the window values to be evaluated
68+
[Aggregation Function](aggregations.md). This will cause the window values to be evaluated
6969
independently for each of the partitions. In the example above, we found the rank of each
7070
Pokemon per `Type 1` partitions. We can see the first couple of each partition if we do
7171
the following:
@@ -166,7 +166,7 @@ print(df.filter(col('"Type 1"') == lit("Bug")).select(
166166

167167
## Aggregate Functions
168168

169-
You can use any [Aggregation Function](../aggregations/) as a window function. Here
169+
You can use any [Aggregation Function](aggregations.md) as a window function. Here
170170
is an example that shows how to compare each pokemons’s attack power with the average attack
171171
power in its `"Type 1"` using the [`avg`][datafusion.functions.avg] function.
172172

@@ -202,7 +202,7 @@ The possible window functions are:
202202
- [`lag`][datafusion.functions.lag]
203203
- [`lead`][datafusion.functions.lead]
204204
3. Aggregate Functions
205-
: - All [Aggregation Functions](../aggregations/) can be used as window functions.
205+
: - All [Aggregation Functions](aggregations.md) can be used as window functions.
206206

207207
## User-Defined Window Functions
208208

docs/source/user-guide/concepts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ For more details on working with DataFrames, including visualization options and
7676

7777
## Expressions
7878

79-
The third statement uses [Expressions](../common-operations/expressions/) to build up a query definition. You can find
79+
The third statement uses [Expressions](common-operations/expressions.md) to build up a query definition. You can find
8080
explanations for what the functions below do in the user documentation for
8181
[`col`][datafusion.col.col], [`lit`][datafusion.lit], [`round`][datafusion.functions.round],
8282
and [`alias`][datafusion.expr.Expr.alias].

docs/source/user-guide/data-sources.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ DataFusion provides a wide variety of ways to get data into a DataFrame to perfo
2424

2525
## Local file
2626

27-
DataFusion has the ability to read from a variety of popular file formats, such as [Parquet](../io/parquet/),
28-
[CSV](../io/csv/), [JSON](../io/json/), and [AVRO](../io/avro/).
27+
DataFusion has the ability to read from a variety of popular file formats, such as [Parquet](io/parquet.md),
28+
[CSV](io/csv.md), [JSON](io/json.md), and [AVRO](io/avro.md).
2929

3030
```python exec="1" source="material-block" result="text" session="data-sources"
3131
ctx = SessionContext()
@@ -208,7 +208,7 @@ Features that are available in PyIceberg but not yet in Iceberg Rust will not be
208208
## Custom Table Provider
209209

210210
You can implement a custom Data Provider in Rust and expose it to DataFusion through the
211-
the interface as describe in the [Custom Table Provider](../io/table_provider/)
211+
the interface as describe in the [Custom Table Provider](io/table_provider.md)
212212
section. This is an advanced topic, but a
213213
[user example](https://github.com/apache/datafusion-python/tree/main/examples/datafusion-ffi-example)
214214
is provided in the DataFusion repository.

docs/source/user-guide/dataframe/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ DataFrames can be created in several ways:
7777
```
7878

7979
For detailed information about reading from different data sources, see the [I/O Guide](../io/index.md).
80-
For custom data sources, see [io_custom_table_provider](../../io/table_provider/).
80+
For custom data sources, see [io_custom_table_provider](../../user-guide/io/table_provider.md).
8181

8282
## Common DataFrame Operations
8383

docs/source/user-guide/sql.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ object. Those objects will be cast into a
115115
[PyArrow Scalar Value](https://arrow.apache.org/docs/python/generated/pyarrow.Scalar.html).
116116

117117
Using `param_values` will rely on the SQL dialect you have configured
118-
for your session. This can be set using the [configuration options](../configuration/)
118+
for your session. This can be set using the [configuration options](configuration.md)
119119
of your [`SessionContext`][datafusion.context.SessionContext]. Similar to how
120120
[prepared statements](https://datafusion.apache.org/user-guide/sql/prepared_statements.html)
121121
work, these parameters are limited to places where you would pass in a

docs/source/user-guide/upgrade-guides.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ let codec = unsafe { data.as_ref() };
9191

9292
## DataFusion 52.0.0
9393

94-
This version includes a major update to the [ffi](ffi) due to upgrades
94+
This version includes a major update to the [ffi](../contributor-guide/ffi.md) due to upgrades
9595
to the [Foreign Function Interface](https://doc.rust-lang.org/nomicon/ffi.html).
9696
Users who contribute their own `CatalogProvider`, `SchemaProvider`,
9797
`TableProvider` or `TableFunction` via FFI must now provide access to a

0 commit comments

Comments
 (0)