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

Refactor SConstruct option handling / extract scons options v2 #1137

Merged
merged 23 commits into from
Nov 22, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
529d6da
[SCons] Update/fix SConstruct formatting
ischoegl Oct 30, 2021
3623959
[SCons] Refactor default option selection in SConstruct
ischoegl Oct 30, 2021
0f40267
[SCons] Switch CamelCase to snake_case for defaults
ischoegl Nov 1, 2021
5d4ad91
[SCons] Document pch_flags defaults
ischoegl Nov 1, 2021
8fca387
[SCons] Document openmp_flag defaults
ischoegl Nov 1, 2021
a844893
[SCons] Update comments
ischoegl Nov 1, 2021
cd43aaf
[SCons] Require SCons >= 3.0.0
ischoegl Nov 1, 2021
2c020f1
[SCons] Implement 'scons get-options'
ischoegl Oct 30, 2021
c1764db
[SCons] Add command line options to get-options
ischoegl Nov 2, 2021
329fa1f
[SCons] Consolidate os.name == 'nt' options
ischoegl Nov 2, 2021
4bac17b
[SCons] Reimplement help based on new objects
ischoegl Nov 2, 2021
d2549af
[SCons] Simplify handling of configurations
ischoegl Nov 3, 2021
2898f32
[SCons] Implement help for specific option
ischoegl Nov 3, 2021
5c6c51f
[SCons] Remove old implementation of 'scons help'
ischoegl Nov 3, 2021
b0c0a2f
[SCons] Make ReST parser accessible from 'scons help'
ischoegl Nov 3, 2021
7d5064d
[SCons] Switch help arguments to options
ischoegl Nov 3, 2021
e709b5e
[SCons] Add 'scons help --list-options'
ischoegl Nov 3, 2021
5cf20ac
[SCons] Add documentation for additional help command options
ischoegl Nov 20, 2021
f6725da
[SCons] Print help comments for 'scons help'
ischoegl Nov 20, 2021
35e583a
[SCons] Consistently use double quotes for configuration options
ischoegl Nov 20, 2021
2ccda53
[SCons] Use consistent type hinting for new classes in buildutils.py
ischoegl Nov 20, 2021
640717f
[CI] Store artifact from docs build
ischoegl Oct 31, 2021
b76e678
[CI] Implicitly test 'scons help' options in 'Build docs' runner
ischoegl Oct 31, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,25 @@ jobs:
sphinxcontrib-katex sphinxcontrib-matlabdomain sphinxcontrib-doxylink
- name: Build Cantera with documentation
run: python3 `which scons` build -j2 doxygen_docs=y sphinx_docs=y debug=n optimize=n use_pch=n
- name: Ensure 'scons help' options work
run: |
python3 `which scons` help --options
python3 `which scons` help --list-options
python3 `which scons` help --option=prefix
- name: Parse configuration options from SConstruct as reST
run: |
python3 `which scons` help --restructured-text --dev --output=config-options-dev.rst
mkdir build/docs/scons
mv config-options-dev.rst build/docs/scons/
- name: Create archive for docs output
run: |
cd build
tar -czf docs.tar.gz docs
- name: Store archive of docs output
uses: actions/upload-artifact@v2
with:
path: build/docs.tar.gz
retention-days: 2
# The known_hosts key is generated with `ssh-keygen -F cantera.org` from a
# machine that has previously logged in to cantera.org and trusts
# that it logged in to the right machine
Expand Down
Loading