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

chore: add Netlify doc previews #4699

Merged
merged 15 commits into from
May 19, 2022
Merged

Conversation

davidbarsky
Copy link
Member

This branch (tries) to setup tracing-style rustdoc previews in PRs; I'm not sure if it works yet. We'll see! I'll update this PR accordingly.

@carllerche
Copy link
Member

Thanks. This will be super helpful to help review PRs. Sometimes, I just want to look at what the public API is and the docs can be an easier medium.

@netlify
Copy link

netlify bot commented May 17, 2022

Deploy Preview for tokio-rs failed.

Name Link
🔨 Latest commit c649eb7
🔍 Latest deploy log https://app.netlify.com/sites/tokio-rs/deploys/62841c7cea5ce52c0b803934

@Darksonn Darksonn added T-docs Topic: documentation A-ci Area: The continuous integration setup labels May 18, 2022
Copy link
Member

@hawkw hawkw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some suggestions regarding the build configuration. once those are addressed, i think this will look good to me

netlify.toml Outdated Show resolved Hide resolved
netlify.toml Show resolved Hide resolved
netlify.toml Show resolved Hide resolved
netlify.toml Outdated Show resolved Hide resolved
davidbarsky and others added 5 commits May 18, 2022 12:20
Co-authored-by: Eliza Weisman <eliza@buoyant.io>
Co-authored-by: Eliza Weisman <eliza@buoyant.io>
Co-authored-by: Eliza Weisman <eliza@buoyant.io>
Co-authored-by: Eliza Weisman <eliza@buoyant.io>
@davidbarsky
Copy link
Member Author

I'm getting the following error when running env RUSTDOCFLAGS="-D warnings --cfg docsrs --cfg tokio_unstable" RUSTFLAGS="--cfg tokio_unstable" cargo +nightly doc --no-deps. This occurs on at least rustc 1.63.0-nightly (4c5f6e627 2022-05-17) (from rustc 1.63.0-nightly (42e1761c7 2022-05-15)); I'll try other nighties before I run cargo-bisect-rustc.

error: unresolved link to `try_join`
  --> tokio/src/macros/join.rs:15:20
   |
15 | /// [`try_join!`]: macro@try_join
   |                    ^^^^^^^^^^^^^^ no item named `try_join` in scope
   |
   = note: `-D rustdoc::broken-intra-doc-links` implied by `-D warnings`
   = note: `macro_rules` named `try_join` exists in this crate, but it is not in scope at this link's location

error: could not document `tokio`

@davidbarsky
Copy link
Member Author

Yup, looks related to rust-lang/rust#96676.

netlify.toml Outdated Show resolved Hide resolved
@davidbarsky davidbarsky requested a review from hawkw May 18, 2022 17:53
netlify.toml Outdated Show resolved Hide resolved
netlify.toml Outdated Show resolved Hide resolved
davidbarsky and others added 2 commits May 18, 2022 13:57
Co-authored-by: Eliza Weisman <eliza@buoyant.io>
Co-authored-by: Eliza Weisman <eliza@buoyant.io>
netlify.toml Outdated Show resolved Hide resolved
netlify.toml Outdated Show resolved Hide resolved
davidbarsky and others added 2 commits May 18, 2022 15:20
Co-authored-by: Alice Ryhl <alice@ryhl.io>
Co-authored-by: Alice Ryhl <alice@ryhl.io>
Copy link
Member

@hawkw hawkw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yay!

@Darksonn Darksonn merged commit 3fce06c into master May 19, 2022
@Darksonn Darksonn deleted the davidbarsky/setup-netlify-previews branch May 19, 2022 07:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-ci Area: The continuous integration setup T-docs Topic: documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants