Skip to content

Commit 6947184

Browse files
bors[bot]dakom
andauthored
[rs] Merge gfx-rs#389
389: build master docs r=grovesNL,kvark a=dakom builds docs and deploys to `doc/` folder on gh_pages branch doesn't interfere with other gh_pages contents. assumes `ACCESS_TOKEN` is set as a github secret (if it isn't, please see https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) see live example on my fork: https://dakom.github.io/wgpu-rs/doc/wgpu/index.html * closes gfx-rs#379 Co-authored-by: David Komer <[email protected]>
2 parents 5055ffd + ffd2ffb commit 6947184

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

.github/workflows/docs.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Documentation
2+
3+
on:
4+
push:
5+
branches: [ master ]
6+
7+
jobs:
8+
bundle:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: checkout repo
12+
uses: actions/checkout@v1
13+
14+
- name: build documentation
15+
run: cargo doc --lib --all-features
16+
17+
- name: Deploy 🚀
18+
uses: JamesIves/github-pages-deploy-action@releases/v3
19+
with:
20+
ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
21+
BRANCH: gh-pages
22+
FOLDER: target/doc
23+
TARGET_FOLDER: doc

0 commit comments

Comments
 (0)