Merge pull request #1790 from subspace/benchmarking-example #1083
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 | |
| concurrency: | |
| group: rustdoc-${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| env: | |
| CARGO_INCREMENTAL: 0 | |
| CARGO_NET_RETRY: 10 | |
| RUSTUP_MAX_RETRIES: 10 | |
| jobs: | |
| rustdoc: | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # @v3.1.0 | |
| - name: Install Protoc | |
| uses: arduino/setup-protoc@64c0c85d18e984422218383b81c52f8b077404d3 # @v1.1.2 | |
| with: | |
| repo-token: ${{ secrets.GITHUB_TOKEN }} | |
| # Build the rust crate docs | |
| - name: Build Documentation | |
| run: cargo doc --all --no-deps --lib | |
| env: | |
| RUSTDOCFLAGS: "-Z unstable-options --enable-index-page" | |
| - name: Deploy Docs | |
| uses: JamesIves/github-pages-deploy-action@ba1486788b0490a235422264426c45848eac35c6 # @v4.4.1 | |
| with: | |
| branch: gh-pages | |
| folder: target/doc |