Skip to content

Commit

Permalink
Docs: Add clearer API doc links (#4461)
Browse files Browse the repository at this point in the history
* Docs: Add clearer API doc links

* prettier
  • Loading branch information
alamb authored Jun 30, 2023
1 parent a11b975 commit 6667646
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 10 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,14 @@ Welcome to the implementation of Arrow, the popular in-memory columnar format, i

This repo contains the following main components:

| Crate | Description | Documentation |
| ------------ | ------------------------------------------------------------------------- | ------------------------------ |
| arrow | Core functionality (memory layout, arrays, low level computations) | [(README)][arrow-readme] |
| parquet | Support for Parquet columnar file format | [(README)][parquet-readme] |
| arrow-flight | Support for Arrow-Flight IPC protocol | [(README)][flight-readme] |
| object-store | Support for object store interactions (aws, azure, gcp, local, in-memory) | [(README)][objectstore-readme] |

See the list of all crates in this repo and their rustdocs [here](https://arrow.apache.org/rust).
| Crate | Description | Latest API Docs | README |
| ------------ | ------------------------------------------------------------------------- | ---------------------------------------------- | ------------------------------ |
| arrow | Core functionality (memory layout, arrays, low level computations) | [docs.rs](https://docs.rs/arrow/latest) | [(README)][arrow-readme] |
| parquet | Support for Parquet columnar file format | [docs.rs](https://docs.rs/parquet/latest) | [(README)][parquet-readme] |
| arrow-flight | Support for Arrow-Flight IPC protocol | [docs.rs](https://docs.rs/arrow-flight/latest) | [(README)][flight-readme] |
| object-store | Support for object store interactions (aws, azure, gcp, local, in-memory) | [docs.rs](https://docs.rs/object_store/latest) | [(README)][objectstore-readme] |

The current development version the API documentation in this repo can be found [here](https://arrow.apache.org/rust).

There are two related crates in a different repository

Expand Down
4 changes: 4 additions & 0 deletions arrow-flight/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@

[![Crates.io](https://img.shields.io/crates/v/arrow-flight.svg)](https://crates.io/crates/arrow-flight)

See the [API documentation](https://docs.rs/arrow_flight/latest) for examples and the full API.

The API documentation for most recent, unreleased code is available [here](https://arrow.apache.org/rust/arrow_flight/index.html).

## Usage

Add this to your Cargo.toml:
Expand Down
4 changes: 3 additions & 1 deletion arrow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,11 @@

This crate contains the official Native Rust implementation of [Apache Arrow][arrow] in memory format, governed by the Apache Software Foundation.

The [crate documentation](https://arrow.apache.org/rust/arrow/index.html) contains examples and full API.
The [API documentation](https://docs.rs/arrow/latest) contains examples and full API.
There are several [examples](https://github.com/apache/arrow-rs/tree/master/arrow/examples) to start from as well.

The API documentation for most recent, unreleased code is available [here](https://arrow.apache.org/rust/arrow/index.html).

## Rust Version Compatibility

This crate is tested with the latest stable version of Rust. We do not currently test against other, older versions.
Expand Down
4 changes: 3 additions & 1 deletion parquet/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@

This crate contains the official Native Rust implementation of [Apache Parquet](https://parquet.apache.org/), which is part of the [Apache Arrow](https://arrow.apache.org/) project.

See [crate documentation](https://arrow.apache.org/rust/parquet/index.html) for examples and the full API.
See the [API documentation](https://docs.rs/parquet/latest) for examples and the full API.

The API documentation for most recent, unreleased code is available [here](https://arrow.apache.org/rust/parquet/index.html).

## Rust Version Compatibility

Expand Down

0 comments on commit 6667646

Please sign in to comment.