-
Notifications
You must be signed in to change notification settings - Fork 52
Host compiler documentation #40
Host compiler documentation #40
Conversation
I've marked this as WIP as it hasn't been tested yet, until the matching Rust PR is merged and that produces tarballs, I'm not sure if it can. |
This tentatively looks good, thanks! I'll take a closer look at rust-lang/rust#49193 now |
Host compiler documentation Fixes #29893. Rust Central Station PR: rust-lang/rust-central-station#40 r? @alexcrichton
Host compiler documentation Fixes #29893. Rust Central Station PR: rust-lang/rust-central-station#40 r? @alexcrichton
Host compiler documentation Fixes #29893. Rust Central Station PR: rust-lang/rust-central-station#40 r? @alexcrichton
Host compiler documentation Fixes rust-lang#29893. Rust Central Station PR: rust-lang/rust-central-station#40 r? @alexcrichton
Host compiler documentation Fixes rust-lang#29893. Rust Central Station PR: rust-lang/rust-central-station#40 r? @alexcrichton
Host compiler documentation Fixes rust-lang#29893. Rust Central Station PR: rust-lang/rust-central-station#40 r? @alexcrichton
Host compiler documentation Fixes rust-lang#29893. Rust Central Station PR: rust-lang/rust-central-station#40 r? @alexcrichton
Renamed this to remove the |
Ok great! One thing I actually realized though is that we'll want to gracefully handle the lack of a rustc-docs tarball as not all the stable/beta/nightly channels are currently producing one? |
@alexcrichton I've pushed a commit that adds a check for this. |
@davidtwco, does this mean we'll have a place to view the API docs for rustc internals once this PR lands? At the moment I'm using a rustc-internal-docs "script" to run @nikomatsakis, @mark-i-m, once this PR merges I believe |
@Michael-F-Bryan If I'm not mistaken, they will be available at |
@Michael-F-Bryan could you open an issue on rustc-guide to change the links? |
So excited for this. =) |
Thanks @davidtwco! This looks great to me now. We've got a release in a few days so I'm gonna hold off on merging this until that's done, but I'll merge and test after that. |
(we've released!) |
Awesome work @davidtwco and @alexcrichton! Will the new internal API docs be available when the next nightly is released? |
I've just now deployed this change to production, and yes hopefully after the next nightly we'll have shiny new docs! |
Where will they be hosted? |
I believe it'll be doc.rust-lang.org/nightly/nightly-rustc |
I'm guessing #43 means we will get this for tomorrow's nightly instead? |
@mark-i-m Yeah, sorry about that, it should work for tomorrow's nightly. |
Documentation is now live! |
Hmm... there appear to be some items missing. For example: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_mir/interpret/index.html?search=mk_eval_cx which should show https://github.com/rust-lang/rust/blob/fb44b4c0eb1d344f84f7bb2c90f28e31a8a180be/src/librustc_mir/interpret/const_eval.rs#L40 Is this expected? |
That's a private module |
|
Documenting private items for internals docs is being discussed here |
Ah, great! Thanks @Manishearth :) |
Since rust-lang/rust-central-station#40 has been merged, we have a stable location for the nightly docs.
This is the second half of rust-lang/rust#29893. The matching rust PR is rust-lang/rust#49193.