name: Docs
on:
push:
branches: [main]
release:
types: [published]
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: pages
cancel-in-progress: true
jobs:
docs:
name: Build & Deploy Docs
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deploy.outputs.page_url }}
steps:
- uses: actions/checkout@v4
- name: Install Rust (stable)
uses: dtolnay/rust-toolchain@stable
- name: Cache cargo
uses: Swatinem/rust-cache@v2
- name: Install mdBook
run: |
curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.5.2/mdbook-v0.5.2-x86_64-unknown-linux-gnu.tar.gz \
| tar xz -C ~/.cargo/bin
- name: Build rustdoc
run: cargo doc --no-deps
- name: Build book
run: mdbook build book
- name: Assemble site
run: |
mkdir -p site
cp -r target/doc site/doc
cp -r book/book site/book
printf '<meta http-equiv="refresh" content="0; url=book/index.html">\n' > site/index.html
- name: Configure Pages
uses: actions/configure-pages@v5
- name: Upload site artifact
uses: actions/upload-pages-artifact@v3
with:
path: site
- id: deploy
name: Deploy to GitHub Pages
uses: actions/deploy-pages@v4