Skip to content

Re-enable relative paths for std links in rustc-docs #153162

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

Open
arferreira wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −0
Open

Re-enable relative paths for std links in rustc-docs #153162

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
10 changes: 10 additions & 0 deletions src/bootstrap/src/core/build_steps/doc.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -953,6 +953,16 @@ impl Step for Rustc {
cargo.rustdocflag("--extern-html-root-url");
cargo.rustdocflag("ena=https://docs.rs/ena/latest/");

// Link std crates to local docs. Installed layout:
// html/ <- std docs (core/, std/, alloc/, ...)
// html/rustc-docs/ <- compiler docs
// `../../` from rustc-docs/*/index.html reaches html/.
Comment on lines +956 to +959
Copy link
Contributor

@eggyal eggyal Mar 2, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

This might be the installed layout, but if someone simply does ./x doc and browses the documentation in their build/doc directory, I guess these relative links won't work? Is that a use case we care about? Perhaps we could change the layout in the build directory to be consistent with the "installed" layout?

Copy link
Contributor Author

@arferreira arferreira Mar 4, 2026

Choose a reason for hiding this comment

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

You're totally right, but changing the build layout to match would be a larger change and might break other assumptions, I mean could be nice but feels like a separate effort.

for krate in STD_PUBLIC_CRATES {
cargo.rustdocflag("--extern-html-root-url");
cargo.rustdocflag(&format!("{krate}=../../"));
}
cargo.rustdocflag("--extern-html-root-takes-precedence");

let mut to_open = None;

let out_dir = builder.stage_out(build_compiler, Mode::Rustc).join(target).join("doc");
Expand Down
Loading