Skip to content

Add Rust docs

Add Rust docs #1

Workflow file for this run

name: Build Docs
on: [push, pull_request]
permissions:
contents: read
pages: write
id-token: write
jobs:
build:
name: Build
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Setup Rust
uses: dtolnay/rust-toolchain@stable
- name: Configure cache
uses: Swatinem/rust-cache@v2
- name: Setup pages
id: pages
uses: actions/configure-pages@v4
- name: Build docs
run: |
cargo clean --doc
cargo doc --workspace --no-deps --lib
cargo doc -p crossbeam-epoch --no-deps
cargo doc -p crossbeam-pebr-epoch --no-deps
# GitHub cannot find the nested index file by default.
# We need to specify the target manually.
- name: Add redirect
run: echo '<meta http-equiv="refresh" content="0;url=smr_benchmark/index.html">' > target/doc/index.html
- name: Remove lock file
run: rm target/doc/.lock
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: target/doc
deploy:
name: Deploy
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4