Skip to content

Commit

Permalink
feat: gen docs
Browse files Browse the repository at this point in the history
  • Loading branch information
martinkersner committed Oct 20, 2024
1 parent d0bd3ca commit c275002
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Publish Documentation

on:
# Trigger the workflow on pushes to the main branch
push:
branches:
- main

# Allows you to manually trigger the workflow from GitHub
workflow_dispatch:

jobs:
build:
runs-on: ubuntu-latest

steps:
# Checkout the repository code
- name: Checkout code
uses: actions/checkout@v3

# Install Rust (default target is fine here)
- name: Install Rust
uses: actions-rs/toolchain@v1
with:
toolchain: stable
profile: minimal
override: true

# Build the documentation
- name: Build documentation
run: cargo doc --no-deps

# Deploy to gh-pages branch
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./target/doc
publish_branch: gh-pages
allow_empty_commit: true

0 comments on commit c275002

Please sign in to comment.