Use verbatim copy of plain text MPL 2.0 (#8) #86
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: rustdoc to gh-pages | |
on: | |
push: | |
branches: | |
- main | |
env: | |
CARGO_TERM_COLOR: always | |
jobs: | |
release: | |
name: GitHub Pages | |
runs-on: ubuntu-latest | |
permissions: | |
contents: write | |
steps: | |
- name: Checkout the Repository | |
uses: actions/checkout@v2 | |
- name: Install the Rust toolchain | |
uses: actions-rs/toolchain@v1 | |
with: | |
toolchain: nightly | |
override: true | |
- name: Build the Documentation | |
run: | | |
RUSTDOCFLAGS="\ | |
--enable-index-page \ | |
--generate-link-to-definition \ | |
--extern-html-root-url ndarray=https://docs.rs/ndarray/0.15/ \ | |
--extern-html-root-url numcodecs=https://juntyr.github.io/numcodecs-rs/ \ | |
--extern-html-root-url pyo3=https://docs.rs/pyo3/0.21/ \ | |
--extern-html-root-url serde=https://docs.rs/serde/1.0/ \ | |
-Zunstable-options\ | |
" cargo doc \ | |
--all-features \ | |
--no-deps | |
- name: Deploy the Documentation | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_branch: gh-pages | |
publish_dir: ./target/doc | |
keep_files: false |