Skip to content

doc/doxygen: Change Default to Light Mode#21292

Merged
AnnsAnns merged 1 commit intoRIOT-OS:masterfrom
crasbe:pr/update_doxyfile
Nov 13, 2025
Merged

doc/doxygen: Change Default to Light Mode#21292
AnnsAnns merged 1 commit intoRIOT-OS:masterfrom
crasbe:pr/update_doxyfile

Conversation

@crasbe
Copy link
Contributor

@crasbe crasbe commented Mar 13, 2025 •
edited
Loading

Contribution description

This just sets the default mode to Light Mode, replacing #21370.

This PR used to include the update of Doxygen, but this was moved to #21372.

Testing procedure

Check that the documentation still looks good. This might has to be done locally because the Workflow CI version of Doxygen is still at 1.9.1.

Issues/PRs references

Depends on (and currently includes) #21372.

@crasbe crasbe requested review from aabadie and jia200x as code owners March 13, 2025 10:28
@github-actions github-actions bot added the Area: doc Area: Documentation label Mar 13, 2025
@crasbe crasbe added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Mar 13, 2025
@crasbe
Copy link
Contributor Author

crasbe commented Mar 13, 2025

This PR fixes the following error messages when building the documentation:

With master and Doxygen version 1.12.0

$ make doc
( cat riot.doxyfile ; echo "GENERATE_HTML = yes" ) | doxygen -
warning: Tag 'OUTPUT_TEXT_DIRECTION' at line 102 of file '-' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'HTML_TIMESTAMP' at line 1365 of file '-' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'FORMULA_TRANSPARENT' at line 1670 of file '-' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'LATEX_SOURCE_CODE' at line 1983 of file '-' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'LATEX_TIMESTAMP' at line 1999 of file '-' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'RTF_SOURCE_CODE' at line 2073 of file '-' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOCBOOK_PROGRAMLISTING' at line 2178 of file '-' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'CLASS_DIAGRAMS' at line 2386 of file '-' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_FONTNAME' at line 2428 of file '-' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_FONTSIZE' at line 2435 of file '-' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_TRANSPARENT' at line 2683 of file '-' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
/home/cbuec/RIOTstuff/riot-stm32wl55/RIOT/cpu/efm32/include/periph_cpu.h:136: warning: member gpio_t belongs to two different groups. The second one found here will be ignored.
...

With this PR and Doxygen version 1.12.0:

$ make doc
( cat riot.doxyfile ; echo "GENERATE_HTML = yes" ) | doxygen -
/home/cbuec/RIOTstuff/riot-stm32wl55/RIOT/cpu/efm32/include/periph_cpu.h:136: warning: member gpio_t belongs to two different groups. The second one found here will be ignored.
...

With master and Doxygen version 1.9.1 (I didn't use make doc because the old Doxygen is not selected by default):

RIOT/doc/doxygen$ ( cat riot.doxyfile ; echo "GENERATE_HTML = yes" ) | /usr/bin/doxygen -
RIOTDoxygenLayout.xml:8: warning: the type 'topics' is not supported for the entry tag within a navindex! Check your layout file!

error: Problems running latex. Check your installation or look for typos in _formulas.tex and check _formulas.log!
...

With this PR and Doxygen version 1.9.1 (relevant for the Workflow CI):

RIOT/doc/doxygen$ ( cat riot.doxyfile ; echo "GENERATE_HTML = yes" ) | /usr/bin/doxygen -
warning: ignoring unsupported tag 'PROJECT_ICON' at line 70, file -
warning: ignoring unsupported tag 'CREATE_SUBDIRS_LEVEL' at line 99, file -
warning: ignoring unsupported tag 'MARKDOWN_ID_STYLE' at line 372, file -
warning: ignoring unsupported tag 'TIMESTAMP' at line 504, file -
warning: ignoring unsupported tag 'SHOW_HEADERFILE' at line 649, file -
warning: ignoring unsupported tag 'EXTERNAL_TOOL_PATH' at line 841, file -
warning: ignoring unsupported tag 'WARN_IF_INCOMPLETE_DOC' at line 883, file -
warning: ignoring unsupported tag 'WARN_IF_UNDOC_ENUM_VAL' at line 901, file -
warning: ignoring unsupported tag 'WARN_LINE_FORMAT' at line 938, file -
warning: ignoring unsupported tag 'INPUT_FILE_ENCODING' at line 1021, file -
warning: ignoring unsupported tag 'FORTRAN_COMMENT_AFTER' at line 1194, file -
warning: ignoring unsupported tag 'HTML_COLORSTYLE' at line 1471, file -
warning: ignoring unsupported tag 'HTML_CODE_FOLDING' at line 1527, file -
warning: ignoring unsupported tag 'HTML_COPY_CLIPBOARD' at line 1538, file -
warning: ignoring unsupported tag 'HTML_PROJECT_COOKIE' at line 1547, file -
warning: ignoring unsupported tag 'DOCSET_FEEDURL' at line 1590, file -
warning: ignoring unsupported tag 'SITEMAP_URL' at line 1687, file -
warning: ignoring unsupported tag 'FULL_SIDEBAR' at line 1811, file -
warning: ignoring unsupported tag 'SHOW_ENUM_VALUES' at line 1827, file -
warning: ignoring unsupported tag 'OBFUSCATE_EMAILS' at line 1848, file -
warning: ignoring unsupported tag 'MATHJAX_VERSION' at line 1896, file -
warning: ignoring unsupported tag 'RTF_EXTRA_FILES' at line 2283, file -
warning: ignoring unsupported tag 'GENERATE_SQLITE3' at line 2401, file -
warning: ignoring unsupported tag 'SQLITE3_OUTPUT' at line 2409, file -
warning: ignoring unsupported tag 'SQLITE3_RECREATE_DB' at line 2417, file -
warning: ignoring unsupported tag 'DOT_COMMON_ATTR' at line 2643, file -
warning: ignoring unsupported tag 'DOT_EDGE_ATTR' at line 2652, file -
warning: ignoring unsupported tag 'DOT_NODE_ATTR' at line 2660, file -
warning: ignoring unsupported tag 'DIR_GRAPH_MAX_DEPTH' at line 2830, file -
warning: ignoring unsupported tag 'MSCGEN_TOOL' at line 2963, file -
RIOTDoxygenLayout.xml:8: warning: the type 'topics' is not supported for the entry tag within a navindex! Check your layout file!

error: Problems running latex. Check your installation or look for typos in _formulas.tex and check _formulas.log!
...

@riot-ci
Copy link

riot-ci commented Mar 13, 2025 •
edited
Loading

Murdock results

✔️ PASSED

ef7bdfc doc: force light mode for the Doxygen documentation

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

Artifacts

mguetschow
mguetschow reviewed Mar 13, 2025
View reviewed changes
@mguetschow
Copy link
Contributor

mguetschow commented Mar 13, 2025

CI check is obviously not happy as it is still using doxygen 1.9.1. We'd either have to add the lines to the doccheck exclude pattern, or defer this PR until we get to sync the CI doxygen version with the website one (@Baertig is currently looking into that). I'd tend to the latter option.

@crasbe
Copy link
Contributor Author

crasbe commented Mar 13, 2025

I'd tend to the latter option.

For sure, there is no rush.

@crasbe crasbe added the State: waiting for CI update State: The PR requires an Update to CI to be performed first label Mar 13, 2025
@crasbe crasbe mentioned this pull request Apr 7, 2025
Closed
maribu
maribu reviewed Apr 7, 2025
View reviewed changes
doc/doxygen/riot.doxyfile Outdated
# The default value is: AUTO_LIGHT.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_COLORSTYLE = AUTO_LIGHT
Copy link
Member

@maribu maribu Apr 7, 2025

Choose a reason for hiding this comment

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

Suggested change
HTML_COLORSTYLE = AUTO_LIGHT
HTML_COLORSTYLE = LIGHT

With that, we could close #21370

@crasbe crasbe force-pushed the pr/update_doxyfile branch from 146732d to 13d1fa5 Compare April 7, 2025 11:36
@crasbe crasbe changed the title doc: Update Doxyfile to Version 1.12.0 doc: Update Doxyfile to Version 1.13.2 Apr 7, 2025
@crasbe crasbe changed the title doc: Update Doxyfile to Version 1.13.2 doc: Update Doxyfile to Version 1.13.2, Change Default to Light Mode Apr 7, 2025
@crasbe crasbe removed the State: waiting for CI update State: The PR requires an Update to CI to be performed first label Apr 7, 2025
@crasbe crasbe mentioned this pull request Apr 7, 2025
Merged
@crasbe crasbe force-pushed the pr/update_doxyfile branch from 13d1fa5 to ec3fc79 Compare November 12, 2025 18:19
@crasbe crasbe requested a review from AnnsAnns as a code owner November 12, 2025 18:19
@github-actions github-actions bot added the Area: tools Area: Supplementary tools label Nov 12, 2025
@crasbe crasbe changed the title doc: Update Doxyfile to Version 1.13.2, Change Default to Light Mode doc: Update Doxyfile to Version 1.15.0, Change Default to Light Mode Nov 12, 2025
@crasbe crasbe added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation State: waiting for other PR State: The PR requires another PR to be merged first labels Nov 12, 2025
@crasbe crasbe force-pushed the pr/update_doxyfile branch from ec3fc79 to ff91b25 Compare November 12, 2025 23:58
@crasbe crasbe changed the title doc: Update Doxyfile to Version 1.15.0, Change Default to Light Mode doc/doxygen: Change Default to Light Mode Nov 12, 2025
@crasbe crasbe added the State: needs rebase State: The codebase was changed since the creation of the PR, making a rebase necessary label Nov 12, 2025
@crasbe
Copy link
Contributor Author

crasbe commented Nov 13, 2025

For reference: Only doc: force light mode for the Doxygen documentation is relevant for this PR.

@crasbe crasbe added the Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer label Nov 13, 2025
@crasbe crasbe force-pushed the pr/update_doxyfile branch from ff91b25 to ef7bdfc Compare November 13, 2025 13:16
@github-actions github-actions bot removed the Area: tools Area: Supplementary tools label Nov 13, 2025
@crasbe crasbe removed State: waiting for other PR State: The PR requires another PR to be merged first State: needs rebase State: The codebase was changed since the creation of the PR, making a rebase necessary labels Nov 13, 2025
AnnsAnns
AnnsAnns approved these changes Nov 13, 2025
View reviewed changes
Copy link
Member

@AnnsAnns AnnsAnns left a comment

Choose a reason for hiding this comment

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

After a careful and long investigation of every single character I can conclude that this PR works, or at least doesn't appear to really break anything.

@AnnsAnns AnnsAnns enabled auto-merge November 13, 2025 13:57
@AnnsAnns AnnsAnns added this pull request to the merge queue Nov 13, 2025
Merged via the queue into RIOT-OS:master with commit 1c87d5f Nov 13, 2025
28 checks passed
@crasbe
Copy link
Contributor Author

crasbe commented Nov 13, 2025

Thank you for the review :)

@crasbe crasbe deleted the pr/update_doxyfile branch November 13, 2025 14:16
@leandrolanzieri leandrolanzieri added this to the Release 2026.01 milestone Jan 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@maribu maribu maribu left review comments

@mguetschow mguetschow mguetschow left review comments

@AnnsAnns AnnsAnns AnnsAnns approved these changes

@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 Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation

Projects

None yet

Milestone

Release 2026.01

Development

Successfully merging this pull request may close these issues.

6 participants

@crasbe @riot-ci @mguetschow @maribu @AnnsAnns @leandrolanzieri