You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by al...@apache.org on 2023/06/26 12:35:05 UTC
[arrow-rs] branch master updated: doc: deploy crate docs to GitHub pages (#4436)
This is an automated email from the ASF dual-hosted git repository.
alamb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git
The following commit(s) were added to refs/heads/master by this push:
new 9c0cae530 doc: deploy crate docs to GitHub pages (#4436)
9c0cae530 is described below
commit 9c0cae5301e0d254af4d64096ae95c2547a7f4a0
Author: xxchan <xx...@gmail.com>
AuthorDate: Mon Jun 26 14:34:59 2023 +0200
doc: deploy crate docs to GitHub pages (#4436)
* deploy docs
* Only deploy if a push to master
* update docs
---
.github/workflows/docs.yml | 29 ++++++++++++++++++++++++++++-
README.md | 2 ++
arrow/README.md | 2 +-
parquet/README.md | 2 +-
4 files changed, 32 insertions(+), 3 deletions(-)
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index bf1bf7aad..a7b9458a1 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 df05d1463..41cf9604a 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 fde716072..eef7db4d2 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 d006c47ec..bb2f96418 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