name: Deploy docs
on:
push:
branches: [main]
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
deploy:
name: Build and deploy docs
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
- name: Install mdbook
uses: taiki-e/install-action@v2
with:
tool: mdbook
- name: Build mdbook site
run: mdbook build
- name: Generate API docs (cargo doc)
run: cargo doc --no-deps --features alloc
- name: Merge cargo doc output into the book
run: |
mkdir -p book/rustdoc
cp -r target/doc/* book/rustdoc/
- name: Bypass Jekyll processing on Pages
run: touch book/.nojekyll
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./book
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4