Skip to content

Fix CI problem with doc generation #89

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

Merged
merged 3 commits into from
Apr 15, 2025
Merged

Fix CI problem with doc generation #89

merged 3 commits into from
Apr 15, 2025

Conversation

d3zd3z
Copy link
Collaborator

@d3zd3z d3zd3z commented Apr 11, 2025

Fix the 'rustdoc' cmake target to have proper dependencies, so that it can be built without having done a full build first.

In addition, fix some documentation warnings that have shown up with the doc runs not having been run.

@d3zd3z d3zd3z requested review from teburd, cfriedt and ithinuel April 11, 2025 21:47
d3zd3z added 3 commits April 15, 2025 10:32
The `new` method on `ZephyrObject` changed to `new_raw`, but this doc
comment was not updated.  Fix.

Signed-off-by: David Brown <[email protected]>
For normal builds, the offsets.h file gets generated before the Rust
target builds.  But, when trying to build just the docs, the dependency
is not explicit, and the file is just not generated.

Fix this by making the dependency explicit.  Like the others, we can't
use the top-level define name, and have to state the dependency target
by expanded name.  This is due to the "fascinating" scoping rules in
cmake.

Signed-off-by: David Brown <[email protected]>
Now that the work-q based futures have been removed, remove lingering
documentation references to this functionality.

Signed-off-by: David Brown <[email protected]>
@d3zd3z d3zd3z changed the title Work around a CI problem with doc generation Fix CI problem with doc generation Apr 15, 2025
@d3zd3z d3zd3z merged commit edcef3b into main Apr 15, 2025
4 checks passed
@d3zd3z d3zd3z deleted the docgen branch April 15, 2025 18:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants