name: Documentation
on:
push:
branches:
- main
jobs:
build:
name: Build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install Rust
uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: nightly
override: true
- name: Build
env:
RUSTDOCFLAGS: "--cfg docsrs"
RUSTFLAGS: "--cfg docsrs"
run: |
cargo +nightly doc --no-deps
- name: Index Redirect
run: |
mkdir .docs
cp -r target/doc/* .docs/
echo > .docs/index.html \
'<!DOCTYPE html><meta http-equiv="refresh" content="0; url=bash_builtins/">'
- name: Upload
uses: actions/upload-pages-artifact@v3.0.1
with:
path: .docs/
deploy:
name: Deploy
needs: build
permissions:
pages: write
id-token: write
runs-on: ubuntu-latest
steps:
- uses: actions/deploy-pages@v4