Skip to content

Use relative paths for std links in rustc-docs - #152243

Merged
rust-bors[bot] merged 1 commit into
rust-lang:mainfrom
arferreira:fix-rustc-docs-local
Feb 7, 2026
Merged

Use relative paths for std links in rustc-docs#152243
rust-bors[bot] merged 1 commit into
rust-lang:mainfrom
arferreira:fix-rustc-docs-local

Conversation

@arferreira

@arferreiraarferreira commented Feb 6, 2026•
edited by rustbot
Loading

Copy link
Copy Markdown
Contributor

Fixes#151496

This adds --extern-html-root-url for each STD_PUBLIC_CRATES entry pointing to ../, so that rustc-docs links to the locally installed rust-docs via relative paths.

r? @GuillaumeGomez@rami3l

@arferreira
Use relative paths for std links in rustc-docs
dcfc23a
Signed-off-by: arferreira <arfs.antonio@gmail.com>
@rustbotrustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) labels Feb 6, 2026
@GuillaumeGomez

GuillaumeGomez commented Feb 6, 2026

Copy link
Copy Markdown
Member

Thanks for the work! One thought I had: how do we test that? ^^'

@arferreira

arferreira commented Feb 6, 2026

Copy link
Copy Markdown
ContributorAuthor

Thanks for the work! One thought I had: how do we test that? ^^'

Yeahh def! I tested manually, just built the compiler docs and comparing the HTML output before and after :)

@GuillaumeGomez

GuillaumeGomez commented Feb 6, 2026

Copy link
Copy Markdown
Member

I expect as much. :p

That was an open question for other rust contributors: how do we check that automatically in the CI to ensure it doesn't regress? Maybe you have an idea @Kobzol ?

@Kobzol

Kobzol commented Feb 6, 2026

Copy link
Copy Markdown
Member

What's the exact thing that you want to check? That all links in the docs are relative? Doesn't rustdoc already has some similar tests in one of its test suites?

@GuillaumeGomez

GuillaumeGomez commented Feb 6, 2026

Copy link
Copy Markdown
Member

Nah, just a few cross-crate ones. And we do, but it's unrelated here: we need this fix because std/core are handled differently and point to each others with https:// and not relative paths. What I want to check is that cross-crate links are using relative paths.

@Kobzol

Kobzol commented Feb 6, 2026•
edited
Loading

Copy link
Copy Markdown
Member

I guess it would either have to be some rustdoc test that scans the HTML (using some existing machinery), or it would require some large-ish changes. Because the docs that we dist are in the dist components, and we don't really have a notion of testing these today, outside of one hardcoded sanity checks for the PGO-ed rustc toolchain.

@GuillaumeGomez

GuillaumeGomez commented Feb 6, 2026

Copy link
Copy Markdown
Member

Nothing we can check then? Oh well, I guess I can live with that.

@bors r+ rollup

@rust-bors

rust-borsBot commented Feb 6, 2026

Copy link
Copy Markdown
Contributor

📌 Commit dcfc23a has been approved by GuillaumeGomez

It is now in the queue for this repository.

@rust-borsrust-borsBot added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Feb 6, 2026
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Feb 6, 2026
@JonathanBrouwer
Rollup merge ofrust-lang#152243- arferreira:fix-rustc-docs-local, r…
b85949f
…=GuillaumeGomez
Use relative paths for std links in rustc-docs
Fixesrust-lang#151496
This adds `--extern-html-root-url` for each `STD_PUBLIC_CRATES` entry pointing to `../`, so that `rustc-docs` links to the locally installed `rust-docs` via relative paths.
r? @GuillaumeGomez@rami3l
@JonathanBrouwerJonathanBrouwer mentioned this pull request Feb 6, 2026
Closed
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Feb 6, 2026
@JonathanBrouwer
Rollup merge ofrust-lang#152243- arferreira:fix-rustc-docs-local, r…
c91c841
…=GuillaumeGomez
Use relative paths for std links in rustc-docs
Fixesrust-lang#151496
This adds `--extern-html-root-url` for each `STD_PUBLIC_CRATES` entry pointing to `../`, so that `rustc-docs` links to the locally installed `rust-docs` via relative paths.
r? @GuillaumeGomez@rami3l
@JonathanBrouwerJonathanBrouwer mentioned this pull request Feb 6, 2026
Closed
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Feb 6, 2026
@JonathanBrouwer
Rollup merge ofrust-lang#152243- arferreira:fix-rustc-docs-local, r…
b38e122
…=GuillaumeGomez
Use relative paths for std links in rustc-docs
Fixesrust-lang#151496
This adds `--extern-html-root-url` for each `STD_PUBLIC_CRATES` entry pointing to `../`, so that `rustc-docs` links to the locally installed `rust-docs` via relative paths.
r? @GuillaumeGomez@rami3l
@JonathanBrouwerJonathanBrouwer mentioned this pull request Feb 6, 2026
Closed
rust-borsBot pushed a commit that referenced this pull request Feb 6, 2026
@bors
Auto merge of#152260- JonathanBrouwer:rollup-ZTLa9e6, r=JonathanBro…
0d8969e
…uwer
Rollup of 5 pull requests
Successful merges:
- #149960 (add `unreachable_cfg_select_predicates` lint)
- #152126 (Convert to inline diagnostics in `rustc_mir_build`)
- #152186 (Convert to inline diagnostics in `rustc_const_eval`)
- #152234 (Dont strip const blocks in array lengths)
- #152243 (Use relative paths for std links in rustc-docs)
@JonathanBrouwerJonathanBrouwer mentioned this pull request Feb 7, 2026
Merged
rust-borsBot pushed a commit that referenced this pull request Feb 7, 2026
@bors
Auto merge of#152264- JonathanBrouwer:rollup-pBsxN9G, r=JonathanBro…
ce9b15c
…uwer
Rollup of 4 pull requests
Successful merges:
- #152126 (Convert to inline diagnostics in `rustc_mir_build`)
- #152186 (Convert to inline diagnostics in `rustc_const_eval`)
- #152234 (Dont strip const blocks in array lengths)
- #152243 (Use relative paths for std links in rustc-docs)
rust-borsBot pushed a commit that referenced this pull request Feb 7, 2026
@bors
Auto merge of#152264- JonathanBrouwer:rollup-pBsxN9G, r=JonathanBro…
c58d9f9
…uwer
Rollup of 4 pull requests
Successful merges:
- #152126 (Convert to inline diagnostics in `rustc_mir_build`)
- #152186 (Convert to inline diagnostics in `rustc_const_eval`)
- #152234 (Dont strip const blocks in array lengths)
- #152243 (Use relative paths for std links in rustc-docs)
@rust-bors
rust-borsBot merged commit 7f514e2 into rust-lang:mainFeb 7, 2026
11 checks passed
rust-timer added a commit that referenced this pull request Feb 7, 2026
@rust-timer
Unrolled build for#152243
a889a4e
Rollup merge of #152243 - arferreira:fix-rustc-docs-local, r=GuillaumeGomez
Use relative paths for std links in rustc-docs
Fixes#151496
This adds `--extern-html-root-url` for each `STD_PUBLIC_CRATES` entry pointing to `../`, so that `rustc-docs` links to the locally installed `rust-docs` via relative paths.
r? @GuillaumeGomez@rami3l
@rustbotrustbot added this to the 1.95.0 milestone Feb 7, 2026
@eggyaleggyal mentioned this pull request Feb 20, 2026
Closed
@arferreiraarferreira mentioned this pull request Feb 22, 2026
Merged
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Feb 23, 2026
@JonathanBrouwer
Rollup merge ofrust-lang#152976- arferreira:revert-relative-extern-…
3e430a1
…paths, r=jieyouxu
Revert relative paths for std links in rustc-docs
Reverts rust-lang#152243.
The relative path `../` passed via `--extern-html-root-url` produces broken links in compiler documentation. The path is wrong in both the published layout (`doc.rust-lang.org/nightly/nightly-rustc/` vs `doc.rust-lang.org/nightly/core/`) and local builds (`compiler-doc/` vs `doc/`).
This restores absolute URLs via `#[doc(html_root_url)]`.
Fixesrust-lang#152917
Re-opens rust-lang#151496
cc @eggyal
rust-timer added a commit that referenced this pull request Feb 24, 2026
@rust-timer
Unrolled build for#152976
c68f4e0
Rollup merge of #152976 - arferreira:revert-relative-extern-paths, r=jieyouxu
Revert relative paths for std links in rustc-docs
Reverts #152243.
The relative path `../` passed via `--extern-html-root-url` produces broken links in compiler documentation. The path is wrong in both the published layout (`doc.rust-lang.org/nightly/nightly-rustc/` vs `doc.rust-lang.org/nightly/core/`) and local builds (`compiler-doc/` vs `doc/`).
This restores absolute URLs via `#[doc(html_root_url)]`.
Fixes#152917
Re-opens #151496
cc @eggyal
@arferreiraarferreira mentioned this pull request Feb 27, 2026
Open
github-actionsBot pushed a commit to rust-lang/rust-analyzer that referenced this pull request Mar 2, 2026
@JonathanBrouwer
Rollup merge of #152976 - arferreira:revert-relative-extern-paths, r=…
453b066
…jieyouxu
Revert relative paths for std links in rustc-docs
Reverts rust-lang/rust#152243.
The relative path `../` passed via `--extern-html-root-url` produces broken links in compiler documentation. The path is wrong in both the published layout (`doc.rust-lang.org/nightly/nightly-rustc/` vs `doc.rust-lang.org/nightly/core/`) and local builds (`compiler-doc/` vs `doc/`).
This restores absolute URLs via `#[doc(html_root_url)]`.
Fixesrust-lang/rust#152917
Re-opens rust-lang/rust#151496
cc @eggyal
ghaaj pushed a commit to ghaaj/polygrammar that referenced this pull request Aug 7, 2026
@JonathanBrouwer
Rollup merge of #152976 - arferreira:revert-relative-extern-paths, r=…
0c60afd
…jieyouxu
Revert relative paths for std links in rustc-docs
Reverts rust-lang/rust#152243.
The relative path `../` passed via `--extern-html-root-url` produces broken links in compiler documentation. The path is wrong in both the published layout (`doc.rust-lang.org/nightly/nightly-rustc/` vs `doc.rust-lang.org/nightly/core/`) and local builds (`compiler-doc/` vs `doc/`).
This restores absolute URLs via `#[doc(html_root_url)]`.
Fixesrust-lang/rust#152917
Re-opens rust-lang/rust#151496
cc @eggyal
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@GuillaumeGomezGuillaumeGomez

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-bootstrapRelevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)

Projects

None yet

Milestone

1.95.0

Development

Successfully merging this pull request may close these issues.

Local rustc-docs could make use of local pages for std types

4 participants

@arferreira@GuillaumeGomez@Kobzol@rustbot