mirror of
https://github.com/rust-lang/rust-analyzer.git
synced 2025-12-27 16:07:46 +00:00
86bc07e91a
rustdoc has a separate environment variable for banning warnings, so set that in the GitHub action configuration. https://github.com/rust-lang/cargo/issues/8424#issuecomment-1070988443 Fix all the rustdoc warnings on unknown types or functions. I've updated references wherever it's obvious, otherwise I've replaced the rustdoc link with plain backticks. There were also some cases where rustdoc links referred to private APIs. I've disabled the rustdoc private API warning in those crates.
36 lines
804 B
YAML
36 lines
804 B
YAML
name: rustdoc
|
|
on:
|
|
push:
|
|
branches:
|
|
- master
|
|
|
|
env:
|
|
CARGO_INCREMENTAL: 0
|
|
CARGO_NET_RETRY: 10
|
|
RUSTFLAGS: "-D warnings -W unreachable-pub"
|
|
RUSTDOCFLAGS: "-D warnings"
|
|
RUSTUP_MAX_RETRIES: 10
|
|
|
|
jobs:
|
|
rustdoc:
|
|
if: github.repository == 'rust-lang/rust-analyzer'
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Checkout repository
|
|
uses: actions/checkout@v4
|
|
|
|
- name: Install Rust toolchain
|
|
run: rustup update --no-self-update stable
|
|
|
|
- name: Build Documentation
|
|
run: cargo doc --all --no-deps
|
|
|
|
- name: Deploy Docs
|
|
uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
|
|
with:
|
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
publish_branch: gh-pages
|
|
publish_dir: ./target/doc
|
|
force_orphan: true
|