`cargo doc --open` doesn't show docs for std crate

RitickMadaan · June 24, 2023, 3:47pm

Hello fellow rustacians,

cargo-doc --open shows documentation for every crate in my project other than std . Am I missing something ?

Thanks in advance

jofas · June 24, 2023, 4:11pm

Currently that is not supported. See this issue for possible workarounds:

github.com/rust-lang/rfcs

`cargo doc` optionally includes stdlib from `rustup`

opened 11:00AM - 07 Feb 18 UTC

adwhit

T-doc T-cargo

A typical set up when writing code is to add all one's dependencies to `Cargo.to…ml` and run `cargo doc --open` to pull up a browser window with all the relevant API docs in one place. But there is one big exception - it is missing the standard lib. For that one must run `rustup doc --std` which of course then opens in a separate tab (possibly in a different instance of the browser). This is made doubly annoying by the fact that many crate docs link back to the standard libary, but when one clicks such a link it redirects to `doc.rustlang.org` rather then the local copy. Proposal: optionally make cargo aware of local stdlib doc instances and hook them into the generated crate docs using the flag `cargo doc --local-std` (bikeshed-able). Then all docs would be accessible from one tab window and one can remain within this closed loop while browsing the docs. This would be especially useful for offline work. Drawbacks: This is arguably a bit of a hack since cargo is not supposed to be aware of rustup (although there are some proposals to eventually combine the two). Possibly difficult to implement, since the current doc generation expects all static files to be in one parent folder. Not clear how e.g. search would work. This feature is a little brittle and would fail if rustup docs cannot be found (or are in an unusual location). It should never be accidentally used for online doc hosting.

RitickMadaan · June 25, 2023, 3:23am

Sure, thanks for sharing @jofas

system · September 23, 2023, 3:24am

This topic was automatically closed 90 days after the last reply. We invite you to open a new topic if you have further questions or comments.