Sphinx argparse

[ischoegl]

Changes proposed in this pull request

Improve documentation of converter scripts.

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

Closes #1577

May create pages that could receive website content (see 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

[codecov]

Codecov Report

Merging #1581 (0539ff5) into main (4b30fa7) will increase coverage by 0.08%.
Report is 4 commits behind head on main.
The diff coverage is 46.15%.

@@            Coverage Diff             @@
##             main    #1581      +/-   ##
==========================================
+ Coverage   70.51%   70.59%   +0.08%     
==========================================
  Files         379      379              
  Lines       59118    59143      +25     
  Branches    21237    21253      +16     
==========================================
+ Hits        41686    41752      +66     
+ Misses      14359    14319      -40     
+ Partials     3073     3072       -1     

Files Changed	Coverage Δ
interfaces/cython/cantera/ck2yaml.py	84.16% <0.00%> (ø)
interfaces/cython/cantera/cti2yaml.py	70.87% <50.00%> (-0.13%)	⬇️
interfaces/cython/cantera/ctml2yaml.py	71.81% <50.00%> (-0.10%)	⬇️
interfaces/cython/cantera/yaml2ck.py	62.67% <50.00%> (-0.32%)	⬇️

... and 10 files with indirect coverage changes

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

[speth]

Thanks, @ischoegl. I think this makes sense, and clearly fits in with Cantera/enhancements#178 without getting too far ahead of ourselves. I had just a couple of minor questions / suggestions.

[ischoegl]

@speth ... this should likewise be ready. I added module-level ck2yaml autodoc documentation, and also deprecated the --id argument (which had already triggered warnings).

PS: Once we get to 3.0, it may make sense to use argparse for ck2yaml as well, so we get consistent documentation. I also believe that tutorials can be merged into this documentation directly.

[speth]

Yes, I agree that modifying ck2yaml to also use argparse would make sense after the 3.0 release.