Skip to content

Update README.md (#275) #336

Update README.md (#275)

Update README.md (#275) #336

Workflow file for this run

name: rustdoc to gh-pages
on:
push:
branches:
- main
env:
CARGO_TERM_COLOR: always
jobs:
release:
name: GitHub Pages
runs-on: ubuntu-latest
steps:
- name: Checkout the Repository
uses: actions/checkout@v2
- name: Install CUDA
uses: Jimver/[email protected]
with:
method: network
use-github-cache: false
use-local-cache: false
- name: Install OpenMPI
run: |
sudo apt-get update -q
sudo apt-get install libopenmpi-dev -y --no-install-recommends
- name: Build the Documentation
run: |
RUSTDOCFLAGS="\
--enable-index-page \
--extern-html-root-url rustacuda=https://docs.rs/rustacuda/0.1.3/ \
--extern-html-root-url rustacuda_core=https://docs.rs/rustacuda_core/0.1.2/ \
--extern-html-root-url rustacuda_derive=https://docs.rs/rustacuda_derive/0.1.2/ \
-Zunstable-options \
" cargo doc \
--workspace \
--all-features \
--no-deps
- name: Deploy the Documentation
uses: peaceiris/actions-gh-pages@v3
with:
deploy_key: ${{ secrets.RUSTDOC_DEPLOY_KEY }}
external_repository: juntyr/necsim-rust-docs
publish_branch: gh-pages
publish_dir: ./target/doc