doc: bump breathe to >=4.23.0 and misc fixes #29483
Merged
Conversation
This file contains 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
utzig
requested review from
carlescufi,
galak,
MaureenHelm and
mbolivar-nordic
as code owners
Breathe>=4.23.0 brings in basic xrefitem rendering support and fixes issues parsing anonymous struct/unions. This version also adds a config knob for showing or hiding enumerator values, so set it to generate documentation compatible with previous versions. Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
Previous Breathe versions had issues parsing anonymous unions/structs which was fixed recently, so those can be removed from .known-issues. Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
Breathe>=4.23.0 renders \xrefitem, including its specializations like \deprecated, so add the proper `()` to symbols existing in previously declared \deprecated messages so they are properly resolved. Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
nashif
approved these changes
Oct 23, 2020
mbolivar-nordic
approved these changes
Oct 23, 2020
carlescufi
approved these changes
Oct 27, 2020
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.
Breathe>=4.23.0 brings in basic xrefitem rendering support and fixes issues parsing anonymous struct/unions. This version also adds a config knob for showing or hiding enumerator values, so set it to generate documentation compatible with previous versions. Remove anonymous struct/union from known-issues. Fix \deprecated usage symbol resolution.
Related to #21061