Skip to content

Commit dc9c669

Browse files
authored
Build rustdoc documentation and update links (#169)
1 parent 1b5aac0 commit dc9c669

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

.github/workflows/deploy_docs.yml

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,23 @@
1-
name: Deploy mdBook
1+
name: Deploy docs
22
on:
33
push:
4-
branches:
4+
branches:
55
- main
66
jobs:
77
build:
88
runs-on: ubuntu-latest
99
steps:
1010
- 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
1318
- uses: JamesIves/[email protected]
1419
with:
1520
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
1621
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.
1823
CLEAN: true # Automatically remove deleted files from the deploy branch

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# 🐉 Rust GPU
22

33
[![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)
45
[![dependency status](https://deps.rs/repo/github/EmbarkStudios/rust-gpu/status.svg)](https://deps.rs/repo/github/EmbarkStudios/rust-gpu)
56
[![Embark](https://img.shields.io/badge/embark-open%20source-blueviolet.svg)](http://embark.dev)
67
[![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:
9394

9495
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.
9596

96-
[gpu-guide]: https://embarkstudios.github.io/rust-gpu/
97+
[gpu-guide]: https://embarkstudios.github.io/rust-gpu/book/
9798

9899
## License
99100

0 commit comments

Comments
 (0)