Cantera / cantera-website

Official Cantera Website
https://cantera.org
Other
15 stars 26 forks source link

Update SCons configuration options to version 2.5.1 #160

Closed ischoegl closed 2 years ago

ischoegl commented 2 years ago

Update config-options.rst to Cantera version 2.5.1

Fixes #159

File content was generated using scons2rst.py script (see Cantera/cantera#1136), with minor manual edits.

ischoegl commented 2 years ago

I also updated the SConstruct option documentation for the current development version, which is 'cut&paste' from scons2rst.py output. Once Cantera/cantera#1136 is merged, the code below Options will be automatically available in the dev folder (as generated by scons2rst.py when the main repo is updated). This can be copied into the toc tree before a website build, and included as ReST in config-options-dev.rst.

ischoegl commented 2 years ago

:tada: ... this appears to be working (based on scons help --restructured-text output).

The solution builds on Cantera/cantera#1137 and Cantera/cantera#1142 (oops).

ischoegl commented 2 years ago

@bryanwweber / @speth ... now that the automatic generation from reST is working (including the newline :joy:) I copied over the system-dependent options from the previous -dev version to the current 2.5.1 documentation. So I think #159 is now fully addressed. Artifacts generated from the CI run include the HTML output ... .