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

Docs fail to build, without the docs feature enabled. #2827

Closed
Frostie314159 opened this issue Dec 17, 2024 · 2 comments
Closed

Docs fail to build, without the docs feature enabled. #2827

Frostie314159 opened this issue Dec 17, 2024 · 2 comments
Labels
bug Something isn't working status:needs-attention This should be prioritized

Comments

@Frostie314159
Copy link
Contributor

Bug description

When generating the docs for any crate, that has esp-hal in the dep-tree, the build fails while documenting esp-hal/src/twai/mod.rs, since embedded-can is only included when the unstable feature is enabled.

To Reproduce

  1. Generate a new crate and point esp-hal to the main branch
  2. Run cargo doc

Expected behavior

Docs don't fail.

Environment

  • Any chip
@Frostie314159 Frostie314159 added bug Something isn't working status:needs-attention This should be prioritized labels Dec 17, 2024
@bugadani
Copy link
Contributor

Please use cargo xtask build-documentation --chips <your chip> --packages esp-hal. Also please note that the whole crate is being overhauled in a major way in this development cycle, where things may or may not work at all before we release it. Breakages like this are expected to happen, especially considering we've barely begun marking APIs unstable.

@Frostie314159
Copy link
Contributor Author

Thanks for the quick response, that resolves the question.

@github-project-automation github-project-automation bot moved this from Todo to Done in esp-rs Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working status:needs-attention This should be prioritized
Projects
Status: Done
Development

No branches or pull requests

2 participants