Improve docs #32
Merged
Improve docs #32
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit improves some of our documentation and allows the crate docs to be built for docs.rs. Signed-off-by: Ionut Mihalcea <ionut.mihalcea@arm.com>
hug-dev
approved these changes
Jan 17, 2020
| @@ -22,3 +24,9 @@ env_logger = "0.7.1" | |||
| [build-dependencies] | |||
| bindgen = "0.52.0" | |||
| pkg-config = "0.3.17" | |||
|
|
|||
| [features] | |||
| docs = [] | |||
There was a problem hiding this comment.
Maybe we will also have to add some of thse dependencies as optional if they do not build on the docs.rs server.
|
Clever fix to allow to have nice docs on docs.rs 😃 In the future we might want to load the library dynamically. |
Agreed, it would've been too much work not justified for now, though |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit improves some of our documentation and allows the crate docs
to be built for docs.rs.