doc/doxygen: do not include RIOTBASE in EXAMPLE_PATH#22415
Open
crasbe wants to merge 2 commits into
Open
Conversation
The includedoc command is obsolete. Partly reverts RIOT-OS#21290.
When the EXAMPLE path is set to the root path, Doxygen will search the entire directory and ignore the filters set in EXCLUDE_*. This is undesired as it will also search in */bin/* subdirectories and the build/* directory, which may contain documentation too that should not be included. Instead, just search in the same directories that INPUT searches in. Partly reverts RIOT-OS#17572.
crasbe
added
Type: bug
github-actions
Bot
added
Area: doc
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
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.
Contribution description
The PR #17572 from @kfessel added the RIOTBASE to the EXAMPLE_PATH in Doxygen. This caused the undesired behavior of Doxygen to ignore the
EXCLUDE_*commands in it's Doxyfile and search everywhere for files, including thebuilddirectory as well as the{tests,examples}/*/bindirectories.This is bad because we neither want to include manufacturer provided docs nor build generated docs (from Micropython) for example.
Reverting that PR will break the CI preview for some packages again, but considering Doxygen 1.9.1 at this point is OLD AF, it's a price worth paying. Also more motivation to finally migrate the Doxygen generation command to
make doc-ci.Note that
EXAMPLE_PATHcan't be empty either, because the@includecommands only work for files specified in this path. I set it to use the same directories asINPUTcurrently does.In PR #21290 I changed the
@includecommand in thepkg/uwb-dw1000/doc.mdfile to@includedoc. That command is deprecated, so I changed it to@include{doc}.Testing procedure
The generated documentation with and without this PR is identical:
Issues/PRs references
Partly reverts #17572 from @kfessel
Partly reverts #21290 from @crasbe
Declaration of AI-Tools / LLMs usage:
AI-Tools / LLMs that were used are: