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.

Sign up for GitHub

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

Jump to bottom

regression: docs.rs no longer showing docs for rerun 0.20 #8165

Closed
astraw opened this issue Nov 17, 2024 · 7 comments
Closed

regression: docs.rs no longer showing docs for rerun 0.20 #8165

astraw opened this issue Nov 17, 2024 · 7 comments
Labels
🪳 bug Something isn't working 📖 documentation Improvements or additions to documentation

Comments

@astraw
Copy link
Contributor

astraw commented Nov 17, 2024

Describe the bug

https://docs.rs/ no longer builds for rerun 0.20.0, but this worked with 0.19.1.

To Reproduce
Steps to reproduce the behavior:

  1. Go to https://docs.rs/crate/rerun/latest
  2. Observe docs.rs failed to build rerun-0.20.0

Expected behavior

  1. Go to https://docs.rs/crate/rerun/latest
  2. Observe correctly built docs

Rerun version
0.20.0

Additional context
I thought this was a spurious network error, but actually it is by design that docs.rs does not allow network access. This is described in the following issue: rust-lang/docs.rs#2674 (comment)
@astraw astraw added 👀 needs triage This issue needs to be triaged by the Rerun team 🪳 bug Something isn't working labels Nov 17, 2024
@astraw astraw mentioned this issue Nov 17, 2024
Closed
@Wumpf Wumpf added 📖 documentation Improvements or additions to documentation and removed 👀 needs triage This issue needs to be triaged by the Rerun team labels Nov 17, 2024
@Wumpf
Copy link
Member

Wumpf commented Nov 17, 2024 •
edited
Loading

We totally missed that! Thank you so much for filing and already checking with rust-long/docs.rs - we'll fix the offending build script and publish a patch soon.

Will need to figure out how to test our docs in an isolated environment like that as well!

@Wumpf
Copy link
Member

Wumpf commented Nov 17, 2024 •
edited
Loading

Meanwhile, we also host our the docs here:
https://ref.rerun.io/docs/rust/stable/rerun/

I'll update the link on our docs to point to that temporarily

@Wumpf Wumpf mentioned this issue Nov 17, 2024
Merged
6 tasks
Wumpf added a commit that referenced this issue Nov 17, 2024
@Wumpf
Use gh-pages hosted rust doc while doc.rs docs are broken (#8166)
cf9299d 
### What

Temporary workaround for:
* #8165

Please revert after we published a patch with working doc.rs

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested the web demo (if applicable):
* Using examples from latest `main` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/8166?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/8166?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!
* [x] If have noted any breaking changes to the log API in
`CHANGELOG.md` and the migration guide

- [PR Build Summary](https://build.rerun.io/pr/8166)
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)

To run all checks from `main`, comment on the PR with `@rerun-bot
full-check`.

To deploy documentation changes immediately after merging this PR, add
the `deploy docs` label.
rerun-bot pushed a commit that referenced this issue Nov 17, 2024
@Wumpf @rerun-bot
Use gh-pages hosted rust doc while doc.rs docs are broken (#8166)
e68818e 
### What

Temporary workaround for:
* #8165

Please revert after we published a patch with working doc.rs

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested the web demo (if applicable):
* Using examples from latest `main` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/8166?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/8166?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!
* [x] If have noted any breaking changes to the log API in
`CHANGELOG.md` and the migration guide

- [PR Build Summary](https://build.rerun.io/pr/8166)
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)

To run all checks from `main`, comment on the PR with `@rerun-bot
full-check`.

To deploy documentation changes immediately after merging this PR, add
the `deploy docs` label.
@Wumpf Wumpf mentioned this issue Nov 18, 2024
Merged
6 tasks
Wumpf added a commit that referenced this issue Nov 19, 2024
@Wumpf @teh-cmc
Fix doc build - run cargo metadata with --offline & --no-deps (#…
91a07f5 
…8168)

### What

* solves #8165
(don't close ticket yet, have to confirm that docs.rs actually works)

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested the web demo (if applicable):
* Using examples from latest `main` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/8168?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/8168?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!
* [x] If have noted any breaking changes to the log API in
`CHANGELOG.md` and the migration guide

- [PR Build Summary](https://build.rerun.io/pr/8168)
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)

To run all checks from `main`, comment on the PR with `@rerun-bot
full-check`.

To deploy documentation changes immediately after merging this PR, add
the `deploy docs` label.

---------

Co-authored-by: Clement Rey <cr.rey.clement@gmail.com>
emilk pushed a commit that referenced this issue Nov 20, 2024
@Wumpf @emilk
Use gh-pages hosted rust doc while doc.rs docs are broken (#8166)
d88faf9 
### What

Temporary workaround for:
* #8165

Please revert after we published a patch with working doc.rs

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested the web demo (if applicable):
* Using examples from latest `main` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/8166?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/8166?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!
* [x] If have noted any breaking changes to the log API in
`CHANGELOG.md` and the migration guide

- [PR Build Summary](https://build.rerun.io/pr/8166)
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)

To run all checks from `main`, comment on the PR with `@rerun-bot
full-check`.

To deploy documentation changes immediately after merging this PR, add
the `deploy docs` label.
emilk pushed a commit that referenced this issue Nov 20, 2024
@Wumpf @teh-cmc @emilk
Fix doc build - run cargo metadata with --offline & --no-deps (#…
0056206 
…8168)

### What

* solves #8165
(don't close ticket yet, have to confirm that docs.rs actually works)

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested the web demo (if applicable):
* Using examples from latest `main` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/8168?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/8168?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!
* [x] If have noted any breaking changes to the log API in
`CHANGELOG.md` and the migration guide

- [PR Build Summary](https://build.rerun.io/pr/8168)
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)

To run all checks from `main`, comment on the PR with `@rerun-bot
full-check`.

To deploy documentation changes immediately after merging this PR, add
the `deploy docs` label.

---------

Co-authored-by: Clement Rey <cr.rey.clement@gmail.com>
@Wumpf
Copy link
Member

Wumpf commented Nov 21, 2024

Fixed in 0.20.1

@Wumpf Wumpf closed this as completed Nov 21, 2024
@astraw
Copy link
Contributor Author

astraw commented Nov 29, 2024

So this happened again in 0.20.2: https://docs.rs/crate/rerun/latest . I don't seem to be able to re-open the issue.

@teh-cmc
Copy link
Member

teh-cmc commented Nov 29, 2024 •
edited
Loading

The docs.rs worker timed out...

[ERROR] error running command: command timed out after 1800 seconds

Thanks for the heads up @astraw -- I'll open an issue (there's nothing we can do on our end though, besides reaching out to them).

@astraw
Copy link
Contributor Author

astraw commented Dec 2, 2024

So it looks the build https://docs.rs/crate/rerun/0.20.2/builds/1569209 passed, used rustc 1.84.0-nightly (3fee0f12e 2024-11-20), and took 24m 50s. On the other hand, the build https://docs.rs/crate/rerun/0.20.2/builds/1567546 failed, used rustc 1.85.0-nightly (6b6a867ae 2024-11-27), and timed out after 1800 seconds, as noted by @teh-cmc.

I'm not sure why docs.rs does not use the successful build, but indeed this doesn't seem like anything rerun can fix by itself.

@astraw
Copy link
Contributor Author

astraw commented Dec 2, 2024

Oh, I think my browser may have cached a stale version. It looks like 0.20.2 docs are online now. https://docs.rs/rerun/0.20.2/rerun/index.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
🪳 bug Something isn't working 📖 documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@astraw @Wumpf @teh-cmc