This repository has been archived by the owner on Feb 21, 2024. It is now read-only.
forked from paritytech/substrate
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
dc117fd
commit b472d65
Showing
1 changed file
with
45 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
name: rustdoc | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
|
||
env: | ||
CARGO_INCREMENTAL: 0 | ||
CARGO_NET_RETRY: 10 | ||
RUSTFLAGS: "-D warnings -W unreachable-pub" | ||
RUSTUP_MAX_RETRIES: 10 | ||
|
||
jobs: | ||
rustdoc: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v2 | ||
|
||
- name: Install Rust toolchain | ||
uses: actions-rs/toolchain@v1 | ||
with: | ||
toolchain: nightly | ||
target: wasm32-unknown-unknown | ||
profile: minimal | ||
override: true | ||
components: rustfmt, rust-src | ||
|
||
# Build the rust crate docs | ||
# Use `RUSTC_BOOTSTRAP` in order to use the `--enable-index-page` flag of rustdoc | ||
# This is needed in order to generate a landing page `index.html` for workspaces | ||
- name: Build Documentation | ||
run: cargo doc --all --no-deps --lib | ||
env: | ||
RUSTC_BOOTSTRAP: 1 | ||
RUSTDOCFLAGS: "-Z unstable-options --enable-index-page" | ||
|
||
- name: Deploy Docs | ||
uses: JamesIves/github-pages-deploy-action@releases/v3 | ||
with: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
BRANCH: gh-pages | ||
FOLDER: target/doc |