Skip to content
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.

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

[src] links point to other website #298

Closed
Nemo157 opened this issue Feb 14, 2019 · 5 comments
Closed

[src] links point to other website #298

Nemo157 opened this issue Feb 14, 2019 · 5 comments
Labels
A-builds Area: Building the documentation for a crate

Comments

@Nemo157
Copy link
Member

Nemo157 commented Feb 14, 2019

The [src] links on https://docs.rs/futures-preview/0.3.0-alpha.12/futures/stream/struct.Forward.html point to https://rust-lang-nursery.github.io/futures-api-docs/0.3.0-alpha.12/futures_util/src/futures_util/stream/forward.rs.html#22-26. This seems likely to be related to the #[doc(html_root_url)] setting in the sub-crate that this type is actually from.

@QuietMisdreavus
Copy link
Member

This is entirely because of the html_root_url attribute, though it should be overridden by a --extern-html-root-url path that docs.rs is passing to rustdoc. Since the build log shows that that flag is being passed, i'm going to assume this is an upstream rustdoc problem. I'll try transferring the issue to rust-lang/rust, since that's where rustdoc lives.

@QuietMisdreavus
Copy link
Member

Apparently you need full admin access to use the "Transfer issue" button, so i've just reopened the issue over there as rust-lang/rust#58472. I'll close the issue here since the work all needs to happen upstream.

@QuietMisdreavus
Copy link
Member

Looks like i was mistaken - it's not a bug in upstream rustdoc, but in docs.rs here. To quote @ollie27 in the rust-lang/rust issue:

The build log shows rustdoc was passed --extern-html-root-url 'futures_util_preview=https://docs.rs/futures-util-preview/0.3.0-alpha.12' but the crate name is futures_util not futures_util_preview. It looks like docs.rs needs to use the actual crate name not the package name.

@jyn514
Copy link
Member

jyn514 commented Feb 1, 2020

This may be fixed by rust-lang/rust#67804.

@jyn514 jyn514 added the A-builds Area: Building the documentation for a crate label Jul 6, 2020
@jyn514
Copy link
Member

jyn514 commented Apr 17, 2021

This was fixed by #1188 (and looking at that PR, looks like this is a duplicate of #1166).

@jyn514 jyn514 closed this as completed Apr 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-builds Area: Building the documentation for a crate
Projects
None yet
Development

No branches or pull requests

3 participants