File tree 2 files changed +12
-6
lines changed
2 files changed +12
-6
lines changed Original file line number Diff line number Diff line change 1
- name : Deploy mdBook
1
+ name : Deploy docs
2
2
on :
3
3
push :
4
- branches :
4
+ branches :
5
5
- main
6
6
jobs :
7
7
build :
8
8
runs-on : ubuntu-latest
9
9
steps :
10
10
- uses : actions/checkout@v2
11
- - run : brew install mdbook
12
- - run : $(cd docs && mdbook build)
11
+ - run : rustup component add rustfmt clippy rust-src rustc-dev llvm-tools-preview
12
+ - run : sudo apt install libwayland-cursor0 libxkbcommon-dev libwayland-dev
13
+ - run : brew install mdbook spirv-tools
14
+ - run : mkdir docs-build/
15
+ - run : $(cd docs && mdbook build -d ../docs-build/book)
16
+ - run : cargo doc
17
+ - run : mv target/doc docs-build/api
13
18
-
uses :
JamesIves/[email protected]
14
19
with :
15
20
GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }}
16
21
BRANCH : gh-pages # The branch the action should deploy to.
17
- FOLDER : docs/book # The folder the action should deploy.
22
+ FOLDER : docs-build # The folder the action should deploy.
18
23
CLEAN : true # Automatically remove deleted files from the deploy branch
Original file line number Diff line number Diff line change 1
1
# 🐉 Rust GPU
2
2
3
3
[ ![ Contributor Covenant] ( https://img.shields.io/badge/contributor%20covenant-v1.4%20adopted-ff69b4.svg )] ( CODE_OF_CONDUCT.md )
4
+ [ ![ API Documentation] ( https://img.shields.io/badge/docs-main-blue )] ( https://embarkstudios.github.io/rust-gpu/api/rustc_codegen_spirv )
4
5
[ ![ dependency status] ( https://deps.rs/repo/github/EmbarkStudios/rust-gpu/status.svg )] ( https://deps.rs/repo/github/EmbarkStudios/rust-gpu )
5
6
[ ![ Embark] ( https://img.shields.io/badge/embark-open%20source-blueviolet.svg )] ( http://embark.dev )
6
7
[ ![ Embark] ( https://img.shields.io/badge/discord-ark-%237289da.svg?logo=discord )] ( https://discord.gg/dAuKfZS )
@@ -93,7 +94,7 @@ There are a few different components to this repo:
93
94
94
95
We welcome community contributions to this project. If you would like to get started, be sure to checkout the [ ` rust-gpu ` dev guide] [ gpu-guide ] and our [ Contributor Guide] ( CONTRIBUTING.md ) for more information on how to get started.
95
96
96
- [ gpu-guide ] : https://embarkstudios.github.io/rust-gpu/
97
+ [ gpu-guide ] : https://embarkstudios.github.io/rust-gpu/book/
97
98
98
99
## License
99
100
You can’t perform that action at this time.
0 commit comments