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

docs are broken/fail to build for 0.5.1 #81

Closed
asutherland opened this issue Oct 1, 2018 · 3 comments
Closed

docs are broken/fail to build for 0.5.1 #81

asutherland opened this issue Oct 1, 2018 · 3 comments

Comments

@asutherland
Copy link
Member

Going to the link from the README of https://docs.rs/rkv/ says "The requested resource does not exist."

Bringing up the crates page at https://docs.rs/crate/rkv/0.5.1 says they failed to build, linking to the log at https://docs.rs/crate/rkv/0.5.1/builds/117580

@mykmelez
Copy link
Contributor

mykmelez commented Oct 1, 2018

That log says the build failed while compiling ordered-float because "error[E0658]: the #[repr(transparent)] attribute is experimental (see issue #43036)":

   Compiling ordered-float v1.0.1
    …
error[E0658]: the `#[repr(transparent)]` attribute is experimental (see issue #43036)
  --> .cargo/registry/src/github.com-1ecc6299db9ec823/ordered-float-1.0.1/src/lib.rs:44:1
   |
44 | #[repr(transparent)]
   | ^^^^^^^^^^^^^^^^^^^^
   |
   = help: add #![feature(repr_transparent)] to the crate attributes to enable

rkv switched back from new-ordered-float to ordered-float in #79. #![feature(repr_transparent)] was stabilized in rust-lang/rust#51562. But that build appears to be using a version of rust from before that stabilization:

$ rustc --version
rustc 1.28.0-dev (b9bf4f162 2018-06-02)

I've added the comment rust-lang/docs.rs#23 (comment) to rust-lang/docs.rs#23, which tracks issues with building crate docs for docs.rs. But a browse of https://github.com/rust-lang-nursery/docs.rs/issues shows unanswered related issues going back a month, such as rust-lang/docs.rs#239, rust-lang/docs.rs#235, rust-lang/docs.rs#233, and rust-lang/docs.rs#231. So this may not get fixed quickly.

In the meantime, a workaround is to generate and browse docs locally: cargo doc --open. Alternately, you can browse the 0.5.0 docs, as that version is identical, except for the change in the ordered-crate dependency: https://docs.rs/crate/rkv/0.5.0

Although this is ultimately a docs.rs problem, I'll leave this issue open until docs.rs is fixed to ensure we track and confirm the fix for rkv.

@mykmelez
Copy link
Contributor

mykmelez commented Oct 22, 2018

The docs.rs repository has moved from onur to rust-lang-nursery, so I updated all the links in the previous comment.

Also, according to rust-lang/docs.rs#23 (comment), the rustc on docs.rs has been updated to a recent nightly, although failed builds haven't been queued to rebuild yet.

Finally, rust-lang/docs.rs#246 notes that https://docs.rs appears to be down. So it isn't currently possible to employ the workaround of loading the 0.5.0 docs. You'll need to generate them locally.

@mykmelez
Copy link
Contributor

mykmelez commented Dec 19, 2018

I asked a docs.rs maintainer to rebuild the docs, and they did so, so the docs for 0.5.1 are now available (as are the docs for the most current version, 0.7.0).

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

No branches or pull requests

2 participants