Add some comments and update documentation link. #89
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 | |
| env: | |
| CARGO_INCREMENTAL: 0 | |
| CARGO_NET_RETRY: 10 | |
| RUSTFLAGS: "-D warnings -W unreachable-pub" | |
| RUSTUP_MAX_RETRIES: 10 | |
| jobs: | |
| rustdoc: | |
| if: github.repository == 'kaist-cp/cs431' | |
| runs-on: [self-hosted, ubuntu-22.04] | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/[email protected] | |
| - name: Install Rustup | |
| run: if ! command -v rustup &>/dev/null; then (curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y); fi | |
| - name: Install Rust toolchain | |
| run: source "$HOME/.cargo/env"; rustup update --no-self-update stable | |
| - name: Build Documentation | |
| run: source "$HOME/.cargo/env"; cd homework; cargo doc --all --document-private-items | |
| - name: Deploy Docs | |
| uses: peaceiris/[email protected] | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_branch: gh-pages | |
| publish_dir: ./homework/target/doc | |
| force_orphan: true |