Skip to content

docs.rs does not produce documentation for sub-crates #128

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

Closed
Marwes opened this issue May 21, 2017 · 4 comments · Fixed by #131
Closed

docs.rs does not produce documentation for sub-crates #128

Marwes opened this issue May 21, 2017 · 4 comments · Fixed by #131

Comments

@Marwes
Copy link

Marwes commented May 21, 2017

In gluon I have a main gluon crate which serves as the easy to use interface for a few different sub-crates. These re-exports do not get links however which makes the documentation rather difficult to browse https://docs.rs/gluon/0.4.0/gluon/#reexports which I suppose is because docs.rs only builds documentation for the crate in question. It might do this for a good reason but would it be possible to at least get documentation built and linked for publicly re-exported crates as well?

@onur
Copy link
Member

onur commented May 21, 2017

Thanks for reporting. This is a limitation of docs.rs and I am working on a solution.

Currently you can define #![doc(html_root_url="https://docs.rs/$crate/$version")] as described in rust-api-guidelines in all your crates to make it work.

@Marwes
Copy link
Author

Marwes commented May 21, 2017

Awesome! I will try to add the root_url and make a new release. Thanks!

Marwes referenced this issue in Marwes/gluon May 23, 2017
@Marwes
Copy link
Author

Marwes commented May 25, 2017

That did the trick https://docs.rs/gluon/0.4.2/gluon/ !

@onur onur mentioned this issue Jun 7, 2017
2 tasks
@onur
Copy link
Member

onur commented Jun 7, 2017

#131 also fixed this issue, you no longer need to set html_root_url, docs.rs will do this automatically for all crates and it's dependencies.

@onur onur closed this as completed Jun 7, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants