-
-
Notifications
You must be signed in to change notification settings - Fork 394
Description
Hi! I'm building a program via the bevy
game engine crate, and in the midst of this, I've found it useful to render documentation for everything via cargo doc
.
However, I noticed that the winapi
crate generates quite a lot of documentation. Unfortunately, cargo doc
has no way to exclude certain dependencies without excluding all dependencies (the --exclude
flag only seems to work on packages that are within the current workspace).
I don't believe this is an issue with the winapi
crate, per se - it's doing its job just fine. However, unless a user is using winapi
directly, they may not need to see winapi
's documentation anyways - meaning winapi
's documentation is simply wasting disk space, and worse, making cargo clean
take a lot longer.
Still, some users may need winapi
's docs, so hiding them behind a blanket #[doc(hidden)]
may not be a good idea. Perhaps winapi
could attach #[doc(hidden)]
to most stuff, unless a certain feature flag (let's say winapi/render_docs
) is specified?
I just think it may be useful to avoid generating so much documentation unless a user needs it.