Skip to content
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

Closed
bstrie opened this issue Mar 10, 2012 · 9 comments
Closed

Rustdoc: allow submodule navigation from crate-level index #1960

bstrie opened this issue Mar 10, 2012 · 9 comments
Labels
C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@bstrie
Copy link
Contributor

bstrie commented Mar 10, 2012

An excerpt from the Rust stdlib crate index page ( http://doc.rust-lang.org/doc/std/index.html ):

  • Module net
  • Module os
  • Module os_fs

The os and os_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 the os or os_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:

  • Module net
  • Module os
    • Module os::libc_constants
    • Native module os::libc
    • Native module os::rustrt
  • Module os_fs
    • Native module os_fs::rustrt
@ghost ghost assigned brson Mar 10, 2012
@ghost ghost assigned z0w0 Apr 23, 2013
@catamorphism
Copy link
Contributor

Nominating for milestone 4, well-covered (having documentation tools work the way we expect is helpful in making sure the documentation covers everything...)

@graydon
Copy link
Contributor

graydon commented Jun 13, 2013

we have an attribute to force documentation already, this is a nice feature but should not block a milestone

@graydon
Copy link
Contributor

graydon commented Jun 13, 2013

just a bug, removing milestone/nomination.

@emberian
Copy link
Member

emberian commented Aug 5, 2013

#8125

/cc @Seldaek

@emberian
Copy link
Member

@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

@Seldaek
Copy link
Contributor

Seldaek commented Aug 15, 2013

Sounds feasible on the main crate page yes, since we only show the other
crates on the left, there is room for a module tree there. I'll add to
the TODOs but not as release critical.

@alexcrichton
Copy link
Member

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.

@emberian
Copy link
Member

ping @bstrie

@alexcrichton
Copy link
Member

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.

@bstrie bstrie unassigned z0w0 Jun 16, 2014
Kobzol pushed a commit to Kobzol/rust that referenced this issue Dec 30, 2024
rust-lang#1960)

* compiletest: specify which special env var and which particular CI job

* compiletest: fix grammar and add link to Dockerfile
bors pushed a commit to rust-lang-ci/rust that referenced this issue Jan 2, 2025
rust-lang#1960)

* compiletest: specify which special env var and which particular CI job

* compiletest: fix grammar and add link to Dockerfile
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

8 participants