Migrate additional website content#1657
Conversation
Reduce the C++ tutorial to a single page. Eliminates some redundant content, and moves some other content that was not specific to the C++ interface to other pages.
Also remove some obsolete "work in progress" admonitions.
bryanwweber
left a comment
bryanwweber
left a comment
There was a problem hiding this comment.
A few suggestions, but lgtm! Merge whenever you want
Co-authored-by: Bryan Weber <[email protected]>
|
Thanks for looking this over, @bryanwweber. I made the suggested changes, which requires re-approval before I can merge. |
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #1657 +/- ##
==========================================
+ Coverage 72.74% 72.75% +0.01%
==========================================
Files 371 375 +4
Lines 56500 56584 +84
Branches 20443 20494 +51
==========================================
+ Hits 41100 41168 +68
- Misses 12385 12401 +16
Partials 3015 3015 ☔ View full report in Codecov by Sentry. |
ischoegl
left a comment
ischoegl
left a comment
There was a problem hiding this comment.
@speth ... thank you for your continued efforts on this.
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.
There was a problem hiding this comment.
I believe the demo C++ files should be moved to samples/cxx, so they can be part of CI?
Same for all other cpp files in this folder.
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. |
3 participants
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 Cantera/enhancements#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