embedded-trainings-2020/embedded-workshop-book/src/api-documentation.md

12 lines
523 B
Markdown
Raw Permalink Normal View History

2020-07-13 11:48:24 +00:00
# Checking the API documentation
We'll be using the `dk` Hardware Abstraction Layer. It's good to have its API documentation handy. You can generate the documentation for that crate from the command line:
2020-07-15 14:28:37 +00:00
✅ Run the following command from within the `advanced/firmware` folder. It will open the generated documentation in your default web browser.
2020-07-13 11:48:24 +00:00
``` console
$ cargo doc -p dk --open
```
2020-07-15 14:28:37 +00:00
> NOTE: If you are using Safari and the documentation is hard to read due to missing CSS, try opening it in a different browser.