Update the changelog entry date for merge #531
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: Docs | |
| on: | |
| push: | |
| branches: | |
| - master | |
| defaults: | |
| run: | |
| # This otherwise gets run under dash which does not support brace expansion | |
| shell: bash | |
| jobs: | |
| docs: | |
| name: Generate and upload docs | |
| runs-on: ubuntu-20.04 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| # Needed for git-describe to do anything useful | |
| - name: Fetch all git history | |
| run: git fetch --force --prune --tags --unshallow | |
| - name: Install dependencies | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y libasound2-dev libgl-dev libjack-dev libx11-xcb-dev libxcb1-dev libxcb-dri2-0-dev libxcb-icccm4-dev libxcursor-dev libxkbcommon-dev libxcb-shape0-dev libxcb-xfixes0-dev | |
| - uses: actions/cache@v3 | |
| # FIXME: Caching `target/` causes the Windows runner to blow up after some time | |
| if: startsWith(matrix.os, 'windows') | |
| with: | |
| path: | | |
| ~/.cargo/registry/index/ | |
| ~/.cargo/registry/cache/ | |
| ~/.cargo/git/db/ | |
| key: ${{ matrix.name }}-${{ matrix.cross-target }} | |
| - uses: actions/cache@v3 | |
| if: "!startsWith(matrix.os, 'windows')" | |
| with: | |
| path: | | |
| ~/.cargo/registry/index/ | |
| ~/.cargo/registry/cache/ | |
| ~/.cargo/git/db/ | |
| target/ | |
| key: ${{ matrix.name }}-${{ matrix.cross-target }} | |
| - name: Set up Rust toolchain | |
| # Nightly is needed to document the SIMD feature and for the | |
| # `doc_auto_cfg` feature | |
| uses: dtolnay/rust-toolchain@nightly | |
| - name: Generate documentation for all targets | |
| # Don't use --all-features here as that will enable a whole bunch of | |
| # conflicting iced features. We also don't want to use `--workspace` | |
| # here because that would also document our plugins and binary crates. | |
| run: >- | |
| cargo doc --features docs,simd,standalone,zstd --no-deps | |
| -p nih_plug | |
| -p nih_plug_derive | |
| -p nih_plug_egui | |
| -p nih_plug_iced | |
| -p nih_plug_vizia | |
| -p nih_plug_xtask | |
| - name: Add a redirect index page | |
| run: | | |
| cat > target/doc/index.html <<EOF | |
| <meta charset="utf-8"> | |
| <meta http-equiv="refresh" content="0; url=nih_plug"> | |
| EOF | |
| - name: Deploy to GitHub Pages | |
| uses: JamesIves/[email protected] | |
| with: | |
| branch: gh-pages | |
| folder: target/doc | |
| # Having the gh-pages branch on this repository adds a whole bunch of | |
| # noise to the GitHub feed if you follow this repo | |
| repository-name: robbert-vdh/nih-plug-docs | |
| ssh-key: ${{ secrets.DOCS_DEPLOY_KEY }} |