Closed speth closed 5 months ago
Thanks for looking this over, @bryanwweber. I made the suggested changes, which requires re-approval before I can merge.
Attention: 16 lines
in your changes are missing coverage. Please review.
Comparison is base (
fb53e96
) 72.74% compared to head (6a056b0
) 72.75%. Report is 2 commits behind head on main.
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
I mainly have a comment on the location of the demo C++ files. I believe that they should be moved to
samples/cxx
so they are covered by CI, which will ensure that they are kept up to date. Whether this is done in this PR or a subsequent one is inconsequential, as long as it is taken care of before the release of 3.1.
I was planning on setting these up to run as part of the test suite but forgot before opening this PR. So, rather than wait and risk forgetting to ever do this, it is now implemented. I went with an option that's slightly different from your suggestion, since I only want to include these samples in the C++ Tutorial and not have them repeated in the Examples section, where I think they would distract from the more interesting example programs.
Changes proposed in this pull request
This PR transfers most of the remaining version-specific content from the cantera-website into this repository. Specifically, this includes:
In addition, a new page has been added to the "Develop" section explaining a bit about how the source material for the documentation is organized and some useful syntax for working with MyST, reST, and Doxygen.
If applicable, fill in the issue number this pull request is fixing
Continues work on https://github.com/Cantera/enhancements/issues/178
If applicable, provide an example illustrating new features this pull request is introducing
Checklist
scons build
&scons test
) and unit tests address code coverage