Skip to content

Commit b14841d

Browse files
adding a workflow that would update the documentation on github pages from updates to the rust doc-strings
1 parent baa8618 commit b14841d

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Generate and Deploy Rust Docs
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- main
7+
8+
jobs:
9+
rust-docs:
10+
name: Generate Rust Documentation
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- name: Checkout repository
15+
uses: actions/checkout@v4
16+
17+
- name: Install Rust
18+
uses: dtolnay/rust-toolchain@stable
19+
20+
- name: Generate documentation
21+
run: cargo doc --no-deps
22+
23+
- name: Deploy to GitHub Pages
24+
if: github.ref == 'refs/heads/main'
25+
uses: peaceiris/actions-gh-pages@v4
26+
with:
27+
github_token: ${{ secrets.GITHUB_TOKEN }}
28+
publish_dir: ./target/doc

0 commit comments

Comments
 (0)