🗒 Documentation #1423
Workflow file for this run
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: 🗒 Documentation | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| merge_group: | |
| jobs: | |
| book: | |
| name: 🔨 Build Docs | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: ⬇ ️Checkout Source | |
| uses: actions/checkout@v2 | |
| - name: 🧰 Install dependencies | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y -q \ | |
| libasound2-dev \ | |
| libudev-dev | |
| - name: 🦀 Install Rust | |
| uses: actions-rs/toolchain@v1 | |
| - name: 📖 Install mdbook | |
| uses: peaceiris/actions-mdbook@v1 | |
| with: | |
| mdbook-version: "0.4.22" | |
| - uses: actions/cache@v3 | |
| name: ♻️ Cache Cargo | |
| with: | |
| path: | | |
| ~/.cargo/registry/index/ | |
| ~/.cargo/registry/cache/ | |
| ~/.cargo/git/db/ | |
| target/ | |
| web-target/ | |
| key: docs-${{ hashFiles('**/Cargo.lock') }} | |
| restore-keys: | | |
| docs- | |
| - name: 🔨 Build Rustdoc | |
| run: | | |
| RUSTDOCFLAGS="--html-in-header docs/rustdoc-mermaid-head.html" cargo doc --workspace --no-deps | |
| # Check for broken doc links in diagrams | |
| for link in `grep -hor 'click .* call docLink\(.*\)' target/doc | awk -F '(' '{ print $2 }' | tr -d ')'`; do | |
| if [ ! -e "target/doc/$link" ]; then | |
| echo "broken doc link in diagram to '$link'" 1>&2; | |
| exit 1; | |
| fi | |
| done | |
| mv target/doc book/src/developers/rustdoc | |
| - name: 🛠 Build MDBook | |
| run: | | |
| cd book | |
| mdbook build | |
| - name: 🚀 Deploy | |
| uses: JamesIves/[email protected] | |
| if: ${{ github.ref == 'refs/heads/main' }} | |
| with: | |
| branch: gh-pages | |
| folder: ./book/dist | |
| target-folder: book |