Skip to content

CI: Skip link-check on external URIs #3966

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kevinjqliu merged 2 commits into from
Sep 14, 2026
Merged

CI: Skip link-check on external URIs #3966

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
79ab49f
Docs: Skip flaky external API documentation links
kevinjqliu Sep 14, 2026
2ec6397
Docs: Require link-check skip comments on external URLs in AGENTS.md
rambleraptor Sep 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@ lives under `pyiceberg/`, organized by concern rather than by engine:

- Large/integration libraries must be **optional extras** in `pyproject.toml`, not core `dependencies`.

### Documentation

- Any external URL mentioned in the docs should have `<!-- markdown-link-check-disable-next-line -->` on the previous line.

## Testing

- Bias towards adding tests to existing files, rather than creating new files.
Expand Down
4 changes: 4 additions & 0 deletions mkdocs/docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1893,6 +1893,7 @@ This will return a Pandas dataframe:
[116981 rows x 3 columns]
```

<!-- markdown-link-check-disable-next-line -->
It is recommended to use Pandas 2 or later, because it stores the data in an [Apache Arrow backend](https://datapythonista.me/blog/pandas-20-and-the-arrow-revolution-part-i) which avoids copies of data.

### DuckDB
Expand Down Expand Up @@ -1961,6 +1962,7 @@ Dataset(
)
```

<!-- markdown-link-check-disable-next-line -->
Using [Ray Dataset API](https://docs.ray.io/en/latest/data/api/dataset.html) to interact with the dataset:

```python
Expand All @@ -1981,6 +1983,7 @@ print(ray_dataset.take(2))

### Bodo

<!-- markdown-link-check-disable-next-line -->
PyIceberg interfaces closely with Bodo Dataframes (see [Bodo Iceberg Quick Start](https://docs.bodo.ai/latest/quick_start/quickstart_local_iceberg/)),
which provides a drop-in replacement for Pandas that applies query, compiler and HPC optimizations automatically.
Bodo accelerates and scales Python code from single laptops to large clusters without code rewrites.
Expand Down Expand Up @@ -2027,6 +2030,7 @@ Bodo is optimized to take advantage of Iceberg features such as hidden partition

### Daft

<!-- markdown-link-check-disable-next-line -->
PyIceberg interfaces closely with Daft Dataframes (see also: [Daft integration with Iceberg](https://docs.daft.ai/en/stable/io/iceberg/)) which provides a full lazily optimized query engine interface on top of PyIceberg tables.

<!-- prettier-ignore-start -->
Expand Down
Loading