mirror of
https://github.com/rust-lang/rust-analyzer.git
synced 2026-03-12 20:00:31 +00:00
9c0d88cc07
rust-analyzer has handy prebuilt `cargo doc` output at https://rust-lang.github.io/rust-analyzer/ide/ However, it doesn't include private definitions, which makes it less useful when trying to learn unfamiliar parts of the codebase. Instead, pass `--document-private-items` so the HTML includes information on private types and modules too. rustdoc renders these with a padlock icon, so it's still clear that they're private. This change also exposes some more rustdoc warnings, which I've fixed.
36 lines
829 B
YAML
36 lines
829 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 --document-private-items
|
|
|
|
- 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
|