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

Fix rustdoc example scraping configuration. #2353

Merged
merged 4 commits into from
Feb 9, 2023

Conversation

xStrom
Copy link
Member

@xStrom xStrom commented Jan 31, 2023

Docs.rs failed to build Druid v0.8.0 docs because we were specifying a stale unstable nightly rustdoc option in our Cargo.toml.

I temporarily disabled this option in #2348.

This PR here brings back example scraping. Unfortunately the rustdoc book is also stale so I had to go deep into the tracking issue to figure out how it changed. The feature can now be disabled on a per example basis, but I enabled it for all of them like was intended before.

I also enabled all the features for docs.rs builds. We used to disable svg and image due to duplicate artifacts. The duplicate artifacts tracking issue is still open, however rustdoc no longer seems to complain for our builds. Perhaps the code changed or the issue is more limited now? Not sure, but I think we can keep the features enabled for now.

I tested this on my own machine with the nightly toolchain and everything seems to work fine.

Critically, I also updated our CI tests. The docs are now built with the nightly toolchain, as that matches docs.rs. I also updated the flags to be a closer match to what docs.rs is configured to use. This way we can hopefully prevent another event where a published build fails on docs.rs. On top of that I made sure we enable our various features in all sorts of CI tests and removed libx11-dev as a seemingly stale Linux dependency.

@xStrom xStrom added maintenance cleans up code or docs S-needs-review waits for review labels Jan 31, 2023
Copy link
Contributor

@jaredoconnell jaredoconnell left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@xStrom xStrom removed the S-needs-review waits for review label Feb 9, 2023
@xStrom xStrom merged commit a2f1a9c into linebender:master Feb 9, 2023
@xStrom xStrom deleted the doc-testing branch February 9, 2023 22:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance cleans up code or docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants