Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update SCons configuration options to version 2.5.1 #160

Merged
merged 4 commits into from
Nov 28, 2021

Conversation

ischoegl
Copy link
Member

@ischoegl ischoegl commented Oct 31, 2021

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 ischoegl marked this pull request as draft October 31, 2021 12:37
@ischoegl ischoegl force-pushed the update-scons-options branch 2 times, most recently from 649b9fe to 305a791 Compare October 31, 2021 13:13
@ischoegl ischoegl marked this pull request as ready for review October 31, 2021 13:20
@ischoegl
Copy link
Member Author

ischoegl commented Oct 31, 2021

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 ischoegl force-pushed the update-scons-options branch 5 times, most recently from 5ccfa23 to 32371bb Compare October 31, 2021 17:00
@ischoegl ischoegl requested a review from a team October 31, 2021 17:02
@ischoegl ischoegl marked this pull request as draft November 22, 2021 13:19
@ischoegl ischoegl force-pushed the update-scons-options branch 8 times, most recently from 45c549b to bb47071 Compare November 22, 2021 17:09
@ischoegl
Copy link
Member Author

ischoegl commented Nov 22, 2021

🎉 ... 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
Copy link
Member Author

ischoegl commented Nov 22, 2021

@bryanwweber / @speth ... now that the automatic generation from reST is working (including the newline 😂) 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 ... .

@ischoegl ischoegl marked this pull request as ready for review November 22, 2021 19:12
Copy link
Member

@speth speth left a comment

Choose a reason for hiding this comment

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

Looks good to me. Thanks, @ischoegl.

@speth speth merged commit 05d5f84 into Cantera:main Nov 28, 2021
@ischoegl ischoegl deleted the update-scons-options branch March 28, 2022 12:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Scons configuration options page still references Cantera 2.4
2 participants