Skip to content
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

Switch doxygen documentation theme #1546

Merged
merged 7 commits into from Jul 19, 2023
Merged

Switch doxygen documentation theme #1546

merged 7 commits into from Jul 19, 2023

Conversation

ischoegl
Copy link
Member

@ischoegl ischoegl commented Jul 18, 2023

Changes proposed in this pull request

Use modern doxygen-awesome-css theme (as mentioned in Cantera/enhancements#115 (comment)) 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

  • The pull request includes a clear description of this code change
  • Commit messages have short titles and reference relevant issues
  • Build passes (scons build & scons test) and unit tests address code coverage
  • Style & formatting of contributed code follows contributing guidelines
  • The pull request is ready for review

@codecov
Copy link

codecov bot commented Jul 18, 2023

Codecov Report

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

❗ 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

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

@ischoegl
Copy link
Member Author

ischoegl commented Jul 18, 2023

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).

Copy link
Member

@speth speth left a comment

Choose a reason for hiding this comment

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

Thanks, @ischoegl! This is definitely an improvement over the default styling. While I suspect there are some additional tweaks we may want to make in time, there's just one issue that I think should make now, noted below.

doc/doxygen/Doxyfile Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

2 participants