RIOT-OS
doc: Update Doxyfile to Version 1.13.2, Change Default to Light Mode
Contribution description
Doxygen adds and removes configuration options with every release and after updating Doxygen from 1.9.1 to ~~1.12.0~~ 1.13.2 (see #21106 and #21300), some deprecated options were left and some new ones were not present in the Doxyfile.
Doxygen has a neat feature that automatically updates the Doxyfile, so it doesn't has to be done manually.
The command is doxygen -u riot.doxyfile in the doc/doxygen folder.
One option I was unsure about is the OBFUSCATE_EMAILS setting in line 1848, but it seems like that just defines how the html code is created:
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
This potentially forces #21289 to rebase because both touch the Doxyfile, but it shouldn't cause any merge conflicts.
Depends on Issue #21106.
Depends on https://github.com/RIOT-OS/murdock-scripts/pull/59
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!
...
Murdock results
:heavy_check_mark: PASSED
ef7bdfc38fc590a0c300884aa0a5f02e20b218ec doc: force light mode for the Doxygen documentation
| Success | Failures | Total | Runtime |
|---|---|---|---|
| 1 | 0 | 1 | 01m:51s |
Artifacts
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.
For reference: Only doc: force light mode for the Doxygen documentation is relevant for this PR.