doc: doxygen: add "Topics" to menus #20443
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
Beginning with doxygen 1.9.8 "Modules" are renamed to "Topics". This patch adds the new entry to the layout file. Having both, "Modules" and "Topics" in the layout file should generate similar output for older and newer doxygen versions.
OlegHahm
force-pushed
the
pr/doxygen/add_topics
branch
from
f9d8def
to
cc14954
Compare
OlegHahm
added
the
CI: ready for build
OlegHahm
added
the
CI: skip compile test
maribu
approved these changes
Mar 1, 2024
maribu
added a commit
to maribu/RIOT
that referenced
this pull request
Mar 26, 2024
This fixes a regression from RIOT-OS#20443 which does cause the modules to re-appear in the side panel, but under the name "Topics" rather than "Modules".
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.
Contribution description
Beginning with doxygen 1.9.8 "Modules" are renamed to "Topics" (see here and here). This patch adds the new entry to the layout file. Having both, "Modules" and "Topics" in the layout file should generate similar output for older and newer doxygen versions.
Testing procedure
Run
make docand check the output. Verify whether the menus (navigation bars) on the left and on top contain either "Modules" or "Topics". Should work with all known doxygen versions.