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

feature request: cargo doc should create an index page and doc pages should link to the index page #1221

Closed
andrewrk opened this issue Jan 25, 2015 · 3 comments

Comments

@andrewrk
Copy link

When I read online documentation, the docs are for the library assuming all the features are turned on. When I search with s I see traits, modules, and functions which are only available for certain features. If I have those features turned off in Cargo.toml then this documentation is at best distracting and at worst misleading. So, the generated documentation UI should provide checkboxes or some other way to toggle features on/off so that you can remove the features that you don't have on when browsing documentation.

I understand that this may require changes in rustdoc.

@andrewrk
Copy link
Author

I think there is a better solution to this, and it is already part way implemented.

When you run cargo doc it creates documentation for all dependencies and takes into account features, which is great. But the generated documentation is missing an index page that lists all the crates.

I tried running cargo doc --open to see what page it defaulted to, but that feature appears to be broken for me.

The search functionality works with all the dependencies' docs together, which is great. I think additionally each doc page should link back to the index. (And there should be an index).

@andrewrk andrewrk changed the title feature request: generated docs should support disabling/enabling features feature request: cargo doc should create an index page and doc pages should link to the index page Jan 29, 2015
@huonw
Copy link
Member

huonw commented Jan 29, 2015

cc rust-lang/rust#16103 (cargo doc basically just calls rustdoc on the various crates.)

@alexcrichton
Copy link
Member

Closing as a dupe of #1016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants