Stream: rustdoc

Topic: Workspace Project index.html


view this post on Zulip XAMPPRocky (Sep 15 2021 at 21:17):

Hey, I don't know if this has been mentioned before, but one of the pain points I've run into when I've needed to deploy rustdoc documentation myself and can't rely on docs.rs is that these projects are often workspace projects, and the generated output doesn't have a top level index.html. This means I usually need to make my own or link to the crates somewhere else. It would be nice if Rustdoc generated an index.html that had a list of the crates generated. For how it would look, I was thinking it would be just the docs.rs homepage but a list of local crates.

Screenshot-2021-09-15-at-22.59.39.png

view this post on Zulip Joshua Nelson (Sep 15 2021 at 21:27):

@XAMPPRocky --enable-index-page -Zunstable-options

view this post on Zulip Joshua Nelson (Sep 15 2021 at 21:27):

it looks like this: https://doc.rust-lang.org/nightly/nightly-rustc/

view this post on Zulip Noah Lev (Sep 16 2021 at 01:05):

Hmm, maybe we should stabilize that feature at some point. We could still change the UI after stabilizing it. I think stabilizing the flag would just say "rustdoc will generate some kind of index page, but how exactly it looks could change".

view this post on Zulip Joshua Nelson (Sep 16 2021 at 02:16):

Sure, that seems reasonable. It doesn't seem hard to support.

view this post on Zulip XAMPPRocky (Sep 16 2021 at 06:57):

@Joshua Nelson Love when a feature I want has already been implemented. :smile:

view this post on Zulip GuillaumeGomez (Sep 16 2021 at 08:44):

@XAMPPRocky it's what we use on the std docs as well :)


Last updated: Oct 11 2021 at 22:34 UTC