Description
When generating docs with cargo doc
, it is often preferred to link external dependencies to existing hosted documentation (docs.rs) instead of regenerating the docs. Currently, running cargo doc
leaves users with the option of either generating all documentation for gdnative
(which is around 200M), or not including links to gdnative
. Neither of these options is particularly desirable as one duplicates documentation and the other doesn't include document links.
Ideally, when users run cargo doc
, they should only generate their own documentation, and have http links to external documentation on docs.rs (or wherever documentation is located).
Adding html_root_url
to the project would allow users of this library to directly link to docs.rs: https://doc.rust-lang.org/rustdoc/the-doc-attribute.html?highlight=link#html_root_url.
Note: There is an open ticket to default to checking docs.rs, but that is old and doesn't seem to be actively developed: rust-lang/rust#42301