Repository navigation
Host compiler documentation #29893
Description
The API documentation for the compiler is useful, and only available online via @Manishearth. It should be hosted by rust-lang.
Need to decide where on the doc server they are hosted - probably separately from the end-user docs; ensure the makefiles can produce them in a separate location from the user docs; add the build rule to the dist builders; make buildbot upload them to the right place.
cc @edunham
Reacted by Phil Hansch
Activity
steveklabnik commentedon Nov 17, 2015
This is a dup of #28309, but gets to the heart of the issue, so I'm going to close it in favor of this one.
I've been talking with @edunham about this a few times over the last few weeks, I think the plan we discussed was a
/internalspath.edunham commentedon Nov 24, 2015
@Manishearth how are you currently generating the contents of https://github.com/Manishearth/rust-internals-docs ?
Manishearth commentedon Nov 24, 2015
./configure --enable-compiler-docs; make docs. I was considering at some point to make it turn on private docs as well (usingrustdoc --passes)29 remaining items
Rollup merge of rust-lang#49193 - davidtwco:issue-29893, r=alexcrichton
davidtwco commentedon Mar 24, 2018
Re-opening as this still depends on this rust-lang/rust-central-station#40 to land.
SimonSapin commentedon Apr 4, 2018
https://doc.rust-lang.org/nightly/nightly-rustc/rustc/ is up. Should it use
RUSTDOCFLAGS="--document-private-items"?davidtwco commentedon Apr 4, 2018
@alexcrichton @SimonSapin I agree that this would be very useful, I've submitted a PR that should handle this: #49654.
kennytm commentedon Apr 4, 2018
If we are documenting private items, I hope rustdoc can clearly indicate that an item is private (or
pub(crate)or whatever restriction). For instance, if I'm working in therustc_mircrate, I would not want to know any private detail about thesyntax_poscrate.Also, I hope there's a
-Zflag to tell rustdoc to shut up about therustc_privatefeature, because we all know the compiler API is unstable 😄.cc @rust-lang/docs
Manishearth commentedon Apr 4, 2018
I've long wanted --document-private-items to produce a "Private" checkbox that lets you toggle private items as well. Maybe I'll work on that if @QuietMisdreavus thinks its a good idea
mark-i-m commentedon Apr 4, 2018
I would appreciate that, since those little yellow boxes take up a lot of space...
EDIT: and all of the
[Experimental]notes everywhere...