doc: hack to hide doc.md files until doxygen gets fixed#21273
Merged
mguetschow merged 1 commit intoRIOT-OS:masterfrom Mar 7, 2025
Merged
doc: hack to hide doc.md files until doxygen gets fixed#21273mguetschow merged 1 commit intoRIOT-OS:masterfrom
mguetschow merged 1 commit intoRIOT-OS:masterfrom
Conversation
Co-Authored-By: carl-tud <[email protected]>
mguetschow
added
the
CI: ready for build
crasbe
approved these changes
Mar 6, 2025
Contributor
crasbe
left a comment
crasbe
left a comment
There was a problem hiding this comment.
I don't understand CSS well enough to judge the code, but I can say that it does work and the elements are present in the HTML code but not visible in the navigation. The content of the groups don't seem to be affected either.
It does not interfere with the latest Doxygen master, so there won't be any "hen-and-egg" issues when updating Doxygen once the new release is out.
I like this hack a lot though, so ACK from my side.
kfessel
approved these changes
Mar 7, 2025
Contributor
kfessel
left a comment
kfessel
left a comment
There was a problem hiding this comment.
looks good to me and
also covers the case when we get our doxygen updated but not every user has
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
Contribution description
As found out in #21220 (comment), doxygen currently adds empty pages for each markdown file it encounters.
Since we still plan to move towards
doc.mdfiles, apply a CSS hack to hide those, until the issue is fixed upstream in doxygen/doxygen#9437Testing procedure
Check CI generated documentation.