Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.
Sign uprustdoc: add flag to control the html_root_url of dependencies #51384
Conversation
rust-highfive
assigned
frewsxcv
Jun 5, 2018
This comment has been minimized.
This comment has been minimized.
|
r? @frewsxcv (rust_highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
label
Jun 5, 2018
This comment has been minimized.
This comment has been minimized.
|
@onur - I modified this slightly from the version you currently use on docs.rs. Mainly, i changed the code to not hard-code docs.rs, by adding the |
rust-highfive
unassigned
frewsxcv
Jun 5, 2018
This comment has been minimized.
This comment has been minimized.
|
The job Click to expand the log.
I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
This comment has been minimized.
This comment has been minimized.
|
This should probably require passing the full URL like I guess this will fix #19603? |
This comment has been minimized.
This comment has been minimized.
That's probably a better solution. @onur, will this work out on your end?
Looks like it! I forgot there was an issue for this, haha. |
This comment has been minimized.
This comment has been minimized.
|
@QuietMisdreavus thank you very much for porting this change. Yes I think @ollie27's solution is better, and it will allow anyone to create his own documentation repository. I'll test this as soon as I can and return to you. |
QuietMisdreavus
force-pushed the
QuietMisdreavus:extern-version
branch
from
1596678
to
696e5bd
Jun 12, 2018
This comment has been minimized.
This comment has been minimized.
|
I've force-pushed a version that uses the single |
QuietMisdreavus
changed the title
rustdoc: add --extern-version and --extern-version-base flags
rustdoc: add flag to control the html_root_url of dependencies
Jun 12, 2018
This comment has been minimized.
This comment has been minimized.
|
The job Click to expand the log.
I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
QuietMisdreavus
force-pushed the
QuietMisdreavus:extern-version
branch
from
878c8fa
to
8c5bf91
Jun 12, 2018
This comment has been minimized.
This comment has been minimized.
|
The job Click to expand the log.
I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
QuietMisdreavus
force-pushed the
QuietMisdreavus:extern-version
branch
from
8c5bf91
to
fcb54f6
Jun 12, 2018
This comment has been minimized.
This comment has been minimized.
|
Ping from triage @rust-lang/rustdoc! This PR needs your review. |
This comment has been minimized.
This comment has been minimized.
|
It's up to @onur in here. :) |
This comment has been minimized.
This comment has been minimized.
|
r? @onur Edit: they're not a member of the org so they can't be assigned to the PR. |
This comment has been minimized.
This comment has been minimized.
|
@onur will just give his approval and at this point I'll |
This comment has been minimized.
This comment has been minimized.
|
Ping from triage @onur! This PR needs your review. |
This comment has been minimized.
This comment has been minimized.
stokhos
commented
Jun 29, 2018
|
Ping from triage @onur will you have time to review this PR? |
This comment has been minimized.
This comment has been minimized.
stokhos
commented
Jul 6, 2018
|
Ping from triage @rust-lang/rustdoc , guys, this PR needs a new reviewer. |
This comment has been minimized.
This comment has been minimized.
|
We were specifically asking for @onur's expertise, as this feature was written for use within docs.rs. |
This comment has been minimized.
This comment has been minimized.
|
You should ask to @onur to review directly on IRC. :) |
This comment has been minimized.
This comment has been minimized.
stokhos
commented
Jul 21, 2018
|
Ping from triage @onur will you have time to review this PR? |
stokhos
added
the
I-nominated
label
Jul 21, 2018
QuietMisdreavus
added
the
T-rustdoc
label
Jul 23, 2018
This comment has been minimized.
This comment has been minimized.
|
Ping from triage @onur! This PR needs your review. |
This comment has been minimized.
This comment has been minimized.
|
Ping from triage @rust-lang/rustdoc. It looks like @onur is unresponsive here. Could you please make a decision on how to move forward with this PR? Otherwise I'll close this, given that it has been blocked for over a month now, as per our triage guidelines. |
This comment has been minimized.
This comment has been minimized.
|
This has been done specifically for |
This comment has been minimized.
This comment has been minimized.
|
Ping from triage @onur! This PR needs your review. |
This comment has been minimized.
This comment has been minimized.
|
Time to get it in. @bors: r+ |
This comment has been minimized.
This comment has been minimized.
|
|
bors
added
S-waiting-on-bors
and removed
S-waiting-on-review
labels
Aug 30, 2018
This comment has been minimized.
This comment has been minimized.
added a commit
that referenced
this pull request
Aug 31, 2018
This comment has been minimized.
This comment has been minimized.
|
|
This comment has been minimized.
This comment has been minimized.
|
The job Click to expand the log.
I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
bors
added
S-waiting-on-review
and removed
S-waiting-on-bors
labels
Aug 31, 2018
This comment has been minimized.
This comment has been minimized.
@bors retry |
bors
added
S-waiting-on-bors
and removed
S-waiting-on-review
labels
Aug 31, 2018
This comment has been minimized.
This comment has been minimized.
added a commit
that referenced
this pull request
Aug 31, 2018
QuietMisdreavus
removed
the
I-nominated
label
Aug 31, 2018
This comment has been minimized.
This comment has been minimized.
|
|
QuietMisdreavus commentedJun 5, 2018
•
edited
The
--extern-html-root-urlflag in this PR allows one to override links to crates whose docs are not already available locally in the doc bundle. Docs.rs currently uses a version of this to make sure links to other crates go into that crate's docs.rs page. See the included test for intended use, but the idea is as follows:Calling rustdoc with
--extern-html-root-url crate=https://some-url.comwill cause rustdoc to override links that point to that crate to instead be replaced with a link rooted athttps://some-url.com/. (e.g. for docs.rs this would behttps://docs.rs/crate/0.1.0or the like.) Cheekily, rustup could use these options to redirect links to std/core/etc to instead point to locally-downloaded docs, if it so desired.Fixes #19603