Use intra-doc-link to fix broken links

[tesuji]

This may fix broken links by missing Deref<Target = str> of String in #32553.

[ehuss]

Just FYI, there is someone working on the string page in #73804.

[tesuji]

Just FYI, there is someone working on the string page in #73804.

Thanks ehuss, I am willing to rebase on #73804 .

[tesuji]

r? @ehuss

[ehuss]

There seems to be some regressions, particularly with primitive links like char. Either they are absolute links to nightly (https://doc.rust-lang.org/nightly/std/primitive.char.html) or they are links to the char module (/std/char/index.html). Perhaps they should use the type@char syntax (or whatever it is now)? I see this also with a few other primitives.

[jyn514]

type@char syntax should work (but you'll need [char][type@char] for it to look nice: #65354).

absolute links to nightly (https://doc.rust-lang.org/nightly/std/primitive.char.html)

Hmm, I thought we fixed this in #74077 ... does this happen in documentation for core or only in std?

[jyn514]

If it happens only in std, then it's because rustdoc assumes the docs for primitives aren't available if they aren't part of the current crate, I tried debugging this in #74077 (comment) without success. cc @sethp

[ehuss]

For this PR, the primitive links only seem to be incorrect on alloc and core.

For example, the top of the page std/str/fn.from_utf8.html has correct links to u8 and str, but the same page at alloc/str/fn.from_utf8.html uses the remote links.

[bors]

☔ The latest upstream changes (presumably #74388) made this pull request unmergeable. Please resolve the merge conflicts.

[tesuji]

type@char syntax

type@char syntax in alloc point to absolute link https://doc.rust-lang.org/nightly/std/primitive.char.html,
in std it points to local link /std/char/index.html .

[tesuji]

In alloc, this points to https://doc.rust-lang.org/nightly/std/primitive.str.html#method.bytes .
But in std, this points to absolute local link: http://0.0.0.0:8000/home/lzutao/fork/rust/compiler/src/liballoc/std/primitive.str.html#method.bytes

And yes, I run http server in doc directory.

[jyn514]

Please file an issue for this bug.

[jyn514]

Actually this is related to cross crate re-exports. So I bet the behavior will change when #73101 lands.

[tesuji]

After stage1, the location in std is Ok http://0.0.0.0:8000/std/primitive.str.html#method.bytes .

[jyn514]

in std it points to local link /std/char/index.html

That's the module, not the primitive type. That was recently fixed (last few days), have you rebased since? You will need to build with stage 1 rustdoc, not the beta compiler.

[tesuji]

Thanks for the tips. After stage1, type@char in std points to correct position at http://0.0.0.0:8000/std/primitive.char.html ,
still in alloc it points to a remote link.

[jyn514]

Ok, if you want that to work in intra-doc links you'll have to wait for #73101 then. Hopefully it will land in the next week or so.

[ollie27]

This may fix #32553.

This won't actually fix #32553 because it is about the missing Methods from Deref<Target=str> section on the alloc::string::String page. This may be able to fix the broken links that were caused by that though.

[tesuji]

Closing in favor of #74485 .