Conditionally hide feature flag docs #4461
Open
+134
−1
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
MabezDev
reviewed
Nov 7, 2025
esp-hal/Cargo.toml
Outdated
| "esp-sync/defmt" | ||
| ] | ||
|
|
||
| #DOC_IF chip("esp32") || chip("esp32s2") || chip("esp32s3") |
Member
There was a problem hiding this comment.
imo this would be better if we used has('psram') based on metadata for the chip we're building documentation for, I think we already use somni to do this elsewhere, can we reuse that code instead of custom handling here?
Contributor
Author
There was a problem hiding this comment.
Somehow missed we already depend on esp-metadata ... sure that should work, too
bjoernQ
force-pushed
the
conditionally-hide-feature-flag-docs
branch
from
5f6997f to
b6ec041
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Thank you for your contribution!
We appreciate the time and effort you've put into this pull request.
To help us review it efficiently, please ensure you've gone through the following checklist:
Submission Checklist 📝
cargo xtask fmt-packagescommand to ensure that all changed code is formatted correctly.CHANGELOG.mdin the proper section.Extra:
Pull Request Details 📖
Description
Closes #4381
This implements kind-of doc-hiding support for features documented via
document-features.It's done by pre-processing Cargo.toml, looking for
#DOC_IF/#DOC_ENDIFcomments.Testing
Building documentation for various chips locally