Skip to content

doc: hack to hide doc.md files until doxygen gets fixed #21273

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 7, 2025

Conversation

mguetschow
Copy link
Contributor

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.md files, apply a CSS hack to hide those, until the issue is fixed upstream in doxygen/doxygen#9437

Testing procedure

Check CI generated documentation.

Co-Authored-By: carl-tud <115627588+carl-tud@users.noreply.github.com>
@github-actions github-actions bot added the Area: doc Area: Documentation label Mar 6, 2025
@mguetschow mguetschow requested review from kfessel and crasbe March 6, 2025 14:00
@mguetschow mguetschow added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Mar 6, 2025
@riot-ci
Copy link

riot-ci commented Mar 6, 2025

Murdock results

✔️ PASSED

67f3d79 doc: hack to hide doc.md files until doxygen gets fixed

Success Failures Total Runtime
1 0 1 01m:16s

Artifacts

Copy link
Contributor

@crasbe crasbe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

image

I like this hack a lot though, so ACK from my side.

Copy link
Contributor

@kfessel kfessel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good to me and
also covers the case when we get our doxygen updated but not every user has

@mguetschow mguetschow added this pull request to the merge queue Mar 7, 2025
Merged via the queue into RIOT-OS:master with commit 999220c Mar 7, 2025
28 checks passed
@mguetschow mguetschow deleted the doxygen-hide-doc.md branch March 7, 2025 09:29
@mguetschow mguetschow added this to the Release 2025.04 milestone Apr 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants