-
Notifications
You must be signed in to change notification settings - Fork 12.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Rustdoc: allow submodule navigation from crate-level index #1960
Comments
Nominating for milestone 4, well-covered (having documentation tools work the way we expect is helpful in making sure the documentation covers everything...) |
we have an attribute to force documentation already, this is a nice feature but should not block a milestone |
just a bug, removing milestone/nomination. |
@Seldaek to implement this would it be possible to have a tree browser of the entire module tree? Along the lines of http://docs.sencha.com/extjs/4.2.1/#!/api, over on the left |
Sounds feasible on the main crate page yes, since we only show the other |
I actually think that the search performs and excellent job of solving this problem. There are already a large number of modules listed at the top of the std/extra crates, so I'm not sure we'd want to clutter it more. Seeing a mock of this though would be kinda cool to see what it'd be like. |
ping @bstrie |
Closing, this bug is specific to the quite old rustdoc now, and the new rustdoc handles this much differently. I think at this point this bug should be reopened to retarget the new rustdoc if it's still an issue. |
rust-lang#1960) * compiletest: specify which special env var and which particular CI job * compiletest: fix grammar and add link to Dockerfile
rust-lang#1960) * compiletest: specify which special env var and which particular CI job * compiletest: fix grammar and add link to Dockerfile
An excerpt from the Rust stdlib crate index page ( http://doc.rust-lang.org/doc/std/index.html ):
The
os
andos_fs
modules both have submodules with their own pages, but currently the only way to access these pages (or even know they exist) is to visit theos
oros_fs
pages themselves and notice the links at the bottom of the table of contents. Showing submodules on the index page would ease navigation and exploration:The text was updated successfully, but these errors were encountered: