This repository has been archived by the owner on Feb 15, 2024. It is now read-only.
Merge pull request #219 from subspace/sep-29 #131
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
| name: rustdoc | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths-ignore: | |
| - '**.md' | |
| - '.gitignore' | |
| env: | |
| CARGO_INCREMENTAL: 0 | |
| CARGO_NET_RETRY: 10 | |
| RUSTUP_MAX_RETRIES: 10 | |
| jobs: | |
| rustdoc: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # v3.1.0 | |
| # On macOS, we need a proper Clang version, not Apple's custom version without wasm32 support | |
| - name: Install LLVM and Clang | |
| uses: KyleMayes/install-llvm-action@8852e4d5c58653ed05135c0a5d949d9c2febcb00 # v1.6.1 | |
| with: | |
| version: "15.0" | |
| - name: Install Protoc | |
| uses: arduino/setup-protoc@149f6c87b92550901b26acd1632e11c3662e381f # v1.3.0 | |
| with: | |
| repo-token: ${{ secrets.GITHUB_TOKEN }} | |
| # 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@ba1486788b0490a235422264426c45848eac35c6 # v4.4.1 | |
| with: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| BRANCH: gh-pages | |
| FOLDER: target/doc |