diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index bf1bf7aad880..a7b9458a1333 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -41,7 +41,7 @@ jobs: container: image: ${{ matrix.arch }}/rust env: - RUSTDOCFLAGS: "-Dwarnings" + RUSTDOCFLAGS: "-Dwarnings --enable-index-page -Zunstable-options" steps: - uses: actions/checkout@v3 with: @@ -56,3 +56,30 @@ jobs: rust-version: ${{ matrix.rust }} - name: Run cargo doc run: cargo doc --document-private-items --no-deps --workspace --all-features + - name: Fix file permissions + shell: sh + run: | + chmod -c -R +rX "target/doc" | + while read line; do + echo "::warning title=Invalid file permissions automatically fixed::$line" + done + - name: Upload artifacts + uses: actions/upload-pages-artifact@v1 + with: + path: target/doc + + deploy: + # Only deploy if a push to master + if: github.ref_name == 'master' && github.event_name == 'push' + needs: docs + permissions: + pages: write # to deploy to Pages + id-token: write # to verify the deployment originates from an appropriate source + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v1 diff --git a/README.md b/README.md index df05d1463b2f..41cf9604af76 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,8 @@ This repo contains the following main components: | 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://apache.github.io/arrow-rs). + There are two related crates in a different repository | Crate | Description | Documentation | diff --git a/arrow/README.md b/arrow/README.md index fde71607246e..eef7db4d2c67 100644 --- a/arrow/README.md +++ b/arrow/README.md @@ -24,7 +24,7 @@ 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://docs.rs/arrow/latest/arrow/) contains examples and full API. +The [crate documentation](https://apache.github.io/arrow-rs/arrow/index.html) contains examples and full API. There are several [examples](https://github.com/apache/arrow-rs/tree/master/arrow/examples) to start from as well. ## Rust Version Compatibility diff --git a/parquet/README.md b/parquet/README.md index d006c47ec148..bb2f96418d30 100644 --- a/parquet/README.md +++ b/parquet/README.md @@ -24,7 +24,7 @@ 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://docs.rs/parquet/latest/parquet/) for examples and the full API. +See [crate documentation](https://apache.github.io/arrow-rs/parquet/index.html) for examples and the full API. ## Rust Version Compatibility