CI: Change doc generation to use a more generic target #54
Conversation
This file contains hidden or 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
Fix this to avoid failing doc generation. Signed-off-by: David Brown <[email protected]>
Rather than targeting a specific board, use a Qemu target, which should make the docs fairly general. The generated devicetree will be minimal, but users wishing to view these docs should be generating them for a specific build anyway. Signed-off-by: David Brown <[email protected]>
d3zd3z
force-pushed
the
gendocs-2025-02-04
branch
from
20019c1 to
8168496
Compare
teburd
approved these changes
Feb 4, 2025
|
typically with rustdoc you'd enable all feature flags, is that sort of thing not possible? |
Well, that's up to the prj.conf in the docgen project. We don't really use features with Zephyr, as they come from Kconfigs. |
This should ensure that we get full coverage in the docs. Signed-off-by: David Brown <[email protected]>
ithinuel
approved these changes
Feb 4, 2025
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.
Rather than targeting a specific board, use a Qemu target, which should make the docs fairly general. The generated devicetree will be minimal, but users wishing to view these docs should be generating them for a specific build anyway.