Skip to content

[rustdoc] Hide items from search but leave it clickable under publiced module #67368

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.

Sign up for GitHub

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

Jump to bottom
Open
tesuji opened this issue Dec 17, 2019 · 3 comments
Open

[rustdoc] Hide items from search but leave it clickable under publiced module #67368

tesuji opened this issue Dec 17, 2019 · 3 comments
Assignees
@GuillaumeGomez
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@tesuji
Copy link
Contributor

tesuji commented Dec 17, 2019 •
edited
Loading

In #67346, I wanted to hide HashMap from search under hash_map module.
https://imgur.com/TkkiEV6.png

It could be nice to have a way to

  • hide items from search but leave it under other publicized module
  • display only one in search for items that are re-publiced in multiple modules.
@tesuji

This comment has been minimized.

Sign in to view
@rustbot rustbot added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Dec 17, 2019
@tesuji tesuji changed the title [rustdoc] Add a new doc attribute that hides items from search but allow leave it clickable under publiced module [rustdoc] Hide items from search but leave it clickable under publiced module Dec 17, 2019
@tesuji tesuji mentioned this issue Dec 17, 2019
Closed
@GuillaumeGomez
Copy link
Member

cc @rust-lang/rustdoc

@GuillaumeGomez
Copy link
Member

As for this topic, I have a few options in mind but I think my favorite is:

#[doc(search_hidden)]

@GuillaumeGomez GuillaumeGomez self-assigned this Oct 29, 2020
@GuillaumeGomez GuillaumeGomez mentioned this issue Oct 29, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@GuillaumeGomez GuillaumeGomez

Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@GuillaumeGomez @tesuji @rustbot