-
Notifications
You must be signed in to change notification settings - Fork 567
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
Clean up cargo manifests and generate more docs. #942
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Code" wise it looks good. I'm wondering about the new doc CI.
Does it have to do a full doc build for each crate or can it utilize the builds of the previous crates?
Because locally it can actually reuse them and thus they would not cause any speed hit,
in which case I would not care at all about the book docs build.
[badges] | ||
travis-ci = { repository = "xi-editor/druid" } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suppose this was removed intentionally? I could not find this badge anywhere on crates.io or docs.rs 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah that's a remnant of a time when druid still used Travis CI.
- name: cargo doc book examples | ||
uses: actions-rs/cargo@v1 | ||
with: | ||
command: doc | ||
args: --manifest-path=docs/book_examples/Cargo.toml --document-private-items |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems consequent, but I'm not sure we need this one?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well might as well make sure that the doc format in the book examples is functional.
The book docs build takes around 20s on the CI, which you can see from the logs. I don't think it's an issue. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see, thanks!
This PR does the following:
im
feature for docs.rs/druid.The
svg
andimage
features run into cargo bugs unfortunately and will have to wait.Cargo.toml
files so that they follow a unified style.