Skip to content

Clean up cargo manifests and generate more docs.#942

Merged
xStrom merged 2 commits intolinebender:masterfrom
xStrom:im-docs
May 15, 2020
Merged

Clean up cargo manifests and generate more docs.#942
xStrom merged 2 commits intolinebender:masterfrom
xStrom:im-docs

Conversation

@xStrom
Copy link
Member

@xStrom xStrom commented May 15, 2020

This PR does the following:

  • Enables the im feature for docs.rs/druid.
    The svg and image features run into cargo bugs unfortunately and will have to wait.
  • Adds CI docs generation for all the crates with their features.
  • Cleans up the Cargo.toml files so that they follow a unified style.

@xStrom xStrom added maintenance cleans up code or docs S-needs-review waits for review labels May 15, 2020
Copy link
Collaborator

@luleyleo luleyleo left a 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.

Comment on lines -20 to -21
[badges]
travis-ci = { repository = "xi-editor/druid" }
Copy link
Collaborator

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 🤔

Copy link
Member Author

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.

Comment on lines +342 to +346
- name: cargo doc book examples
uses: actions-rs/cargo@v1
with:
command: doc
args: --manifest-path=docs/book_examples/Cargo.toml --document-private-items
Copy link
Collaborator

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?

Copy link
Member Author

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.

@xStrom
Copy link
Member Author

xStrom commented May 15, 2020

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.

Copy link
Collaborator

@luleyleo luleyleo left a comment

Choose a reason for hiding this comment

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

I see, thanks!

@xStrom xStrom merged commit 57e5437 into linebender:master May 15, 2020
@xStrom xStrom deleted the im-docs branch May 15, 2020 15:03
@xStrom xStrom removed the S-needs-review waits for review label May 15, 2020
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.

2 participants