name: Build and Publish Docs
on:
push:
branches:
- main
workflow_dispatch:
jobs:
docs:
name: Build Rust Docs
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install Rust
uses: actions-rs/toolchain@v1
with:
toolchain: stable
override: true
- name: Build docs
id: build-docs
run: cargo doc --workspace --all-features --document-private-items
- name: Upload docs artifact
if: success()
uses: actions/upload-artifact@v4
with:
name: rust-docs
path: target/doc
- name: Deploy to GitHub Pages
if: success() && steps.build-docs.outcome == 'success'
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: target/doc
publish_branch: gh-pages
user_name: "neuxdotdev"
user_email: "noreply@github.com"