Skip to content

Exceptions for setting html_root_url and documentation to docs.rs #78

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Closed
dtolnay opened this issue May 29, 2017 · 5 comments
Closed

Exceptions for setting html_root_url and documentation to docs.rs #78

dtolnay opened this issue May 29, 2017 · 5 comments

Comments

@dtolnay
Copy link
Member

dtolnay commented May 29, 2017

The main one I know of is docs.rs only supports documenting the default feature set: https://github.com/onur/docs.rs/issues/29.

Dependency on system libraries may also be a problem.

@dtolnay dtolnay changed the title Exceptions for setting html_root_url to docs.rs Exceptions for setting html_root_url and documentation to docs.rs May 29, 2017
@dtolnay
Copy link
Member Author

dtolnay commented May 29, 2017

@onur
Copy link
Member

onur commented Jun 7, 2017

Since https://github.com/onur/docs.rs/pull/131 docs.rs is automatically setting html_root_url for crates and it's dependencies. I think C-HTML-ROOT can be removed from rust-api-guidelines.

Also docs.rs now supports building non-default features.

@dtolnay
Copy link
Member Author

dtolnay commented Oct 29, 2017

I removed the html_root_url guideline in 5c457df and the docs.rs guideline in b7a831e.

@dtolnay dtolnay closed this as completed Oct 29, 2017
@CAD97
Copy link

CAD97 commented Mar 26, 2020

Why was C-HTML-ROOT was re-added in b36cc0d? It seems that it's not needed anymore. Should it just be re-removed now?

@dtolnay
Copy link
Member Author

dtolnay commented Mar 26, 2020

It still makes a difference for cargo doc --no-deps local builds. Without it, rustdoc doesn't link to types from your crate.

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

No branches or pull requests

3 participants