Skip to content

Mentions rustc-docs for rustc_private #2844

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tshepang merged 1 commit into from
Apr 22, 2026
Merged

Mentions rustc-docs for rustc_private #2844

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions src/rustc-driver/external-rustc-drivers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,22 @@ When developing out-of-tree projects that use `rustc_private` crates, you can co

This configuration allows `rust-analyzer` to properly recognize and provide IDE support for `rustc_private` crates in out-of-tree projects.

### Getting Specific Nightly Documentation for `rustc_private`
### Getting Nightly Documentation for `rustc_private`

The nightly-rustc internal crates' documentation is only available for the latest nightly. If you depend on compiler internals from an older nightly, you may want to refer to the internal documentation from that particular nightly. The only way to do this is to generate the documentation locally. For example, to get documentation for `nightly-2025-11-08`:
#### Latest Nightly

For the latest nightly, you can install the `rustc-docs` component and open it directly in your browser:

```sh
rustup component add rustc-docs
rustup doc --rustc-docs
```

> Note: The `rustc-docs` component is only available for recent nightly toolchains and may not be present for every nightly date. It was first introduced in [PR #75560](https://github.com/rust-lang/rust/pull/75560) (August 2020).
Copy link
Copy Markdown
Member

@tshepang tshepang Apr 22, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wow, that's a long time... thought it was more recent, but I guess that only applies to not-amd64

View changes since the review


#### Older Nightlies

If you depend on compiler internals from an older nightly, you may want to refer to the internal documentation from that particular nightly. The only way to do this is to generate the documentation locally. For example, to get documentation for `nightly-2025-11-08`:

Get the Git commit hash for that nightly:

Expand Down
Loading