From 6667646660fb0f3248b3cb02e77d89f1ac4f3cf2 Mon Sep 17 00:00:00 2001 From: Andrew Lamb Date: Fri, 30 Jun 2023 07:15:21 -0400 Subject: [PATCH] Docs: Add clearer API doc links (#4461) * Docs: Add clearer API doc links * prettier --- README.md | 16 ++++++++-------- arrow-flight/README.md | 4 ++++ arrow/README.md | 4 +++- parquet/README.md | 4 +++- 4 files changed, 18 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 53220620a304..c3108917e87a 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/arrow-flight/README.md b/arrow-flight/README.md index d4fddba70b7c..9194b209fe72 100644 --- a/arrow-flight/README.md +++ b/arrow-flight/README.md @@ -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: diff --git a/arrow/README.md b/arrow/README.md index adf32ff61bf2..fb2119e3bc15 100644 --- a/arrow/README.md +++ b/arrow/README.md @@ -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. diff --git a/parquet/README.md b/parquet/README.md index 19f34fd877fa..86c7ee2c35d0 100644 --- a/parquet/README.md +++ b/parquet/README.md @@ -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