Skip to content
This repository has been archived by the owner on Feb 18, 2024. It is now read-only.

Commit

Permalink
Improved github page generation (#1233)
Browse files Browse the repository at this point in the history
Improved docs
  • Loading branch information
jorgecarleitao authored Aug 20, 2022
1 parent cfb0d58 commit 57f2a86
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 16 deletions.
32 changes: 20 additions & 12 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ jobs:
guide:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3

- name: Setup mdBook
uses: peaceiris/actions-mdbook@v1
Expand All @@ -15,6 +15,20 @@ jobs:

- run: mdbook build guide

- name: Deploy
if: github.ref == 'refs/heads/docs_test' || startsWith(github.ref, 'refs/tags/v')
uses: peaceiris/actions-gh-pages@v3.7.3
with:
personal_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./guide/book
destination_dir: ./${{github.ref_name}}/guide
keep_files: false

docs:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v3

- name: Install Rust toolchain
uses: actions-rs/toolchain@v1
with:
Expand All @@ -23,24 +37,18 @@ jobs:
override: true
components: rustfmt, rust-src

- uses: Swatinem/rust-cache@v1

- name: Build Documentation
run: cargo doc --lib --features full --no-deps
env:
RUSTDOCFLAGS: --cfg docsrs

- name: Deploy
if: github.ref == 'refs/heads/main'
if: github.ref == 'refs/heads/docs_test' || startsWith(github.ref, 'refs/tags/v')
uses: peaceiris/actions-gh-pages@v3.7.3
with:
personal_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./guide/book
publish_dir: ./target/doc/arrow2
destination_dir: ./${{github.ref_name}}/docs
keep_files: false

- name: Deploy
if: github.ref == 'refs/heads/main'
uses: peaceiris/actions-gh-pages@v3.7.3
with:
personal_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./target/doc
destination_dir: ./docs
keep_files: true
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ A Rust crate to work with [Apache Arrow](https://arrow.apache.org/).
The most feature-complete implementation of the Arrow format after the C++
implementation.

Check out [the guide](https://jorgecarleitao.github.io/arrow2/) for a general introduction
on how to use this crate, and
[API docs](https://jorgecarleitao.github.io/arrow2/docs/arrow2/index.html) for a detailed
documentation of each of its APIs.
Check out [the guide](https://jorgecarleitao.github.io/arrow2/main/guide)
for a general introduction on how to use this crate, and
[API docs](https://jorgecarleitao.github.io/arrow2/main/docs)
for a detailed documentation of each of its APIs.

## Features

Expand Down

0 comments on commit 57f2a86

Please sign in to comment.