Skip to content

Migrate YAML docs#1638

Merged
ischoegl merged 6 commits intoCantera:mainfrom
speth:yaml-docs
Oct 22, 2023
Merged

Migrate YAML docs#1638
ischoegl merged 6 commits intoCantera:mainfrom
speth:yaml-docs

Conversation

@speth
Copy link
Copy Markdown
Member

@speth speth commented Oct 21, 2023

Changes proposed in this pull request

  • Migrate YAML-related documentation into the versioned Sphinx documentation
  • Re-organize this content a bit, within the "User Guide" section of the website
    • A short introduction, syntax overview, and discussion of included input files is given in the "Introduction to YAML Input Files"
    • Under the "task guides", we have:
      • "Converting Chemkin Format Files"
      • "Creating YAML Mechanism Files from Scratch" (which has been condensed to a single page),
      • "Converting Data from NASA ThermoBuild"
      • "Handling Errors in Input Files"
      • "Converting Legacy CTI and XML Input Files to YAML"

If applicable, fill in the issue number this pull request is fixing

Continues work on Cantera/enhancements#178.

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

@speth speth added Input Input parsing and conversion (for example, ck2yaml) documentation labels Oct 21, 2023
@codecov
Copy link
Copy Markdown

codecov bot commented Oct 21, 2023

Codecov Report

Merging #1638 (db3fc12) into main (3a9bc6a) will decrease coverage by 0.01%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #1638      +/-   ##
==========================================
- Coverage   72.69%   72.68%   -0.01%     
==========================================
  Files         370      370              
  Lines       56298    56298              
  Branches    20375    20403      +28     
==========================================
- Hits        40925    40922       -3     
+ Misses      12376    12369       -7     
- Partials     2997     3007      +10
Files Coverage Δ
interfaces/cython/cantera/ck2yaml.py 84.65% <100.00%> (ø)

... and 4 files with indirect coverage changes

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

ischoegl
ischoegl approved these changes Oct 22, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@ischoegl ischoegl left a comment

Choose a reason for hiding this comment

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

Thanks, @speth!

@ischoegl ischoegl merged commit 60ea75a into Cantera:main Oct 22, 2023
@speth speth deleted the yaml-docs branch July 23, 2024 15:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ischoegl ischoegl ischoegl approved these changes

Assignees

No one assigned

Labels

documentation Input Input parsing and conversion (for example, ck2yaml)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@speth @ischoegl