Feature Request: Rustdoc is resistant to internals documentation, underserving the community of package maintainers
Closed this issue · 1 comments
Rustdoc, by design, doesn't document crate internals without special flags, and then when given the --document-private-items flag, interleaves internals documentation with the library package 's public API. There is an alternative, to provide a link in the crate main page to package internals documented on a separate group of pages. Without this, package maintainers, who need to know about those internals, are underserved, and must create some special and nonstandard web island where they can read the documentation relevant to them. Thus, package maintainers are in general discouraged from documenting internals as well as they might with better facilities in Rustdoc.
The idly curious are also underserved, and of course internals documentation is a good start to learning how to do many things.
Providing this facility would result in an increase in documentation size, but not a troubling one in modern times. It could also be enabled with a flag, but please make it possible to set that flag in Cargo.toml .
See also #304 from February 2019.