Skip to content

doc/doxygen: force light mode via CSS hack#21370

Closed
maribu wants to merge 1 commit intoRIOT-OS:masterfrom
maribu:doxygen/for-light-mode
Closed

doc/doxygen: force light mode via CSS hack#21370
maribu wants to merge 1 commit intoRIOT-OS:masterfrom
maribu:doxygen/for-light-mode

Conversation

@maribu
Copy link
Member

@maribu maribu commented Apr 7, 2025

Contribution description

Until the dark mode is porperly supported, we should rather force the light mode. This prevents an issue with low contrast font.

Testing procedure

Low contrast text like this:

image

Should be gone in the CI preview.

Issues/PRs references

None

@maribu maribu added Type: bug The issue reports a bug / The PR fixes a bug (including spelling errors) Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR labels Apr 7, 2025
@maribu maribu requested review from aabadie and jia200x as code owners April 7, 2025 10:19
@riot-ci
Copy link

riot-ci commented Apr 7, 2025 •
edited
Loading

Murdock results

✔️ PASSED

fe2242b doc/doxygen: force light mode via CSS hack

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

Artifacts

@maribu
Copy link
Member Author

maribu commented Apr 7, 2025

That's not quite working yet

@maribu maribu force-pushed the doxygen/for-light-mode branch from 884941d to c86a803 Compare April 7, 2025 10:34
@crasbe
Copy link
Contributor

crasbe commented Apr 7, 2025 •
edited
Loading

I'm not sure if we shouldn't rather try to update Doxygen to a newer version and use the https://www.doxygen.nl/manual/config.html#cfg_html_colorstyle HTML_COLORSTYLE tag to force light mode.

In theory the only change required to update Doxygen would be to change the make doc command in riotdocker for the CI murdock-scripts for the CI.

Edit: Likewise the command for generating the website has to be changed, but I don't remember where it is.

@maribu
doc/doxygen: force light mode via CSS hack
fe2242b 
Until the dark mode is porperly supported, we should rather force the
light mode. This prevents an issue with low contrast font.
@maribu maribu force-pushed the doxygen/for-light-mode branch from c86a803 to fe2242b Compare April 7, 2025 10:52
@crasbe
Copy link
Contributor

crasbe commented Apr 7, 2025

That won't work with Doxygen 1.9.1 I'm afraid. The HTML_COLORSTYLE tag is introduced with newer Doxygen versions and the best place to update it would be either this PR or a follow-up PR: #21292

But that PR depends on the RIOT CI to be updated (which I didn't create a PR for yet) 🫠

@crasbe
Copy link
Contributor

crasbe commented Apr 7, 2025

See: RIOT-OS/murdock-scripts#59

@maribu maribu mentioned this pull request Apr 7, 2025
Merged
@maribu
Copy link
Member Author

maribu commented Apr 7, 2025

Closing in favor of: #21292

@maribu maribu closed this Apr 7, 2025
@maribu maribu deleted the doxygen/for-light-mode branch April 7, 2025 11:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@aabadie aabadie Awaiting requested review from aabadie aabadie is a code owner

@jia200x jia200x Awaiting requested review from jia200x jia200x is a code owner

Assignees

No one assigned

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 Type: bug The issue reports a bug / The PR fixes a bug (including spelling errors)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@maribu @riot-ci @crasbe

Comments