name: Docs
on:
push:
branches: [main]
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup Rust
uses: dtolnay/rust-toolchain@stable
- name: Cache cargo
uses: actions/cache@v4
with:
path: |
~/.cargo/registry
~/.cargo/git
target
key: ${{ runner.os }}-cargo-docs-${{ hashFiles('Cargo.lock') }}
- name: Generate Rust docs
run: cargo doc --no-deps
- name: Stage Rust docs into docs/rust
run: |
mkdir -p docs/rust
cp -r target/doc/. docs/rust/
- name: Setup .NET
uses: actions/setup-dotnet@v4
with:
dotnet-version: 8.0.x
- name: Install DocFX
run: dotnet tool install -g docfx
- name: Build DocFX site
working-directory: docs
run: |
docfx metadata
docfx build
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/_site
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