-
Notifications
You must be signed in to change notification settings - Fork 612
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
docs.rs integration #419
Comments
On the technical side I'd be more than willing to also set up webhooks for docs.rs to receive prompt notifications of new versions. Otherwise though we may want to start out with an opt-in form of "integrate this crate with docs.rs" and then gradually we can fill in to all crates that are otherwise missing a documentation link. I like the idea of a badge here as well, looks nifty to me! |
/cc #381 also /cc @ashleygwilliams, npm has stuff like this, and she was even trying to write something to subscribe to them with futures |
I'm in favor of auto-linking to docs.rs :) |
Me as well. This will be really handy. Is it possible to hint to docs.rs to build a docs with certain feature flags enabled? This is useful for libraries optionally exposing serde implementations. |
@erickt that is the next thing I will be working on, see onur/docs.rs#29 |
Not currently, but it's been one of the most common feature requests. On Thu, Sep 1, 2016 at 1:31 PM, Erick Tryzelaar [email protected]
|
I'd like to see this as well, for any crates that don't already have documentation links. Many that do should migrate to docs.rs as well, for convenient cross-referencing; we may want to start steering people in that direction once crates.io uses it by default. |
Duplicating the status from #459 and #506: docs.rs now provides a way that crates.io can query for build status, so this issue is now for implementing a use of that information that only shows a docs.rs link on crates.io if the latest build has succeeded. There's documentation for the way to query docs.rs in: #506 (comment) |
Ok, so what needs to be done for this is:
As far as specifically how to implement this, I'm not entirely sure, but I'm thinking something along the lines of changing this
and then have javascript that looks for I'm open to better ideas though, I'm not sure if there's a good way to do this with Ember? Please let me know if you have any questions about working on this! |
And also document this behavior over in the docs that live in cargo, around here |
See this comment for detailed info on what we're currently thinking of for the implementation
Recently, @onur released the awesome https://docs.rs/ , which autogenerates documentation from crates hosted on crates.io.
A lot of people have been asking how this might integrate with crates.io, so I wanted to open this thread to discuss possibilities.
One possibility I'd thought of: we could take any crate which doesn't have a "documentation" link, and replace it with a link to the page on crates.rs. @onur also thought that maybe a badge would work.
/cc @rust-lang/core
The text was updated successfully, but these errors were encountered: