Cantera / cantera

Chemical kinetics, thermodynamics, and transport tool suite
https://cantera.org
Other
582 stars 342 forks source link

Switch doxygen documentation theme #1546

Closed ischoegl closed 11 months ago

ischoegl commented 11 months ago

Changes proposed in this pull request

Use modern doxygen-awesome-css theme (as mentioned in https://github.com/Cantera/enhancements/issues/115#issuecomment-1477177638) and put details on top via customized xml layout

Rendered Webpage

image

vs. current theme (after #1543)

image

Relevant Issues

Somewhat relevant to Cantera/enhancements#115

Checklist

codecov[bot] commented 11 months ago

Codecov Report

Merging #1546 (071d862) into main (6fc22c4) will decrease coverage by 0.01%. The diff coverage is n/a.

:exclamation: Current head 071d862 differs from pull request most recent head 3c56269. Consider uploading reports for the commit 3c56269 to get more accurate results

@@            Coverage Diff             @@
##             main    #1546      +/-   ##
==========================================
- Coverage   70.50%   70.50%   -0.01%     
==========================================
  Files         376      379       +3     
  Lines       59081    59091      +10     
  Branches    21222    21228       +6     
==========================================
+ Hits        41657    41661       +4     
- Misses      14344    14351       +7     
+ Partials     3080     3079       -1     
Impacted Files Coverage Δ
include/cantera/base/AnyMap.h 80.00% <ø> (ø)
include/cantera/base/Array.h 82.75% <ø> (ø)
include/cantera/base/ExternalLogger.h 39.13% <ø> (ø)
include/cantera/base/Interface.h 100.00% <ø> (ø)
include/cantera/base/NoExitLogger.h 0.00% <ø> (ø)
include/cantera/base/Solution.h 87.50% <ø> (ø)
include/cantera/base/SolutionArray.h 94.44% <ø> (ø)
include/cantera/base/Units.h 90.90% <ø> (ø)
include/cantera/base/YamlWriter.h 100.00% <ø> (ø)
include/cantera/base/ctexceptions.h 60.86% <ø> (ø)
... and 68 more

... and 15 files with indirect coverage changes

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

ischoegl commented 11 months ago

I added a couple of tweaks that became possible with DoxygenLayout.xml, and fixed a couple of formatting glitches I stumbled across. I am not planning on adding anything else, i.e. this is ready for a review. (I also checked that the GH doxygen artifacts look as expected).