Skip to content

Commit

Permalink
[CI] Handle building examples with sphinx-gallery
Browse files Browse the repository at this point in the history
  • Loading branch information
speth committed Sep 23, 2023
1 parent ec41c38 commit 1c47765
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -322,9 +322,11 @@ jobs:
run: python3 -m pip install -U pip setuptools wheel
- name: Install Python dependencies
run: |
python3 -m pip install ruamel.yaml scons numpy cython sphinx==5.1.1 \
sphinxcontrib-matlabdomain sphinxcontrib-doxylink pint \
pydata-sphinx-theme==0.13.3 sphinx-argparse
python3 -m pip install ruamel.yaml scons numpy cython sphinx==6.2.1 \
sphinxcontrib-matlabdomain sphinxcontrib-doxylink pint \
pydata-sphinx-theme==0.13.3 sphinx-argparse
python3 -m pip install "git+https://github.com/speth/sphinx-gallery.git@multi-src-lang"
python3 -m pip install "git+https://github.com/speth/sphinx-tags.git@tags-with-spaces"
- 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
Expand All @@ -335,12 +337,12 @@ jobs:
- 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/
mkdir build/doc/scons
mv config-options-dev.rst build/doc/scons/
- name: Create archive for docs output
run: |
cd build
tar -czf docs.tar.gz docs
tar -czf docs.tar.gz doc
- name: Store archive of docs output
uses: actions/upload-artifact@v3
with:
Expand All @@ -362,7 +364,7 @@ jobs:
RSYNC_USER: "ctdeploy"
RSYNC_SERVER: "cantera.org"
RSYNC_DEST: "cantera/documentation/dev"
DOCS_OUTPUT_DIR: "./build/docs/"
DOCS_OUTPUT_DIR: "./build/doc/"
run: |
rsync -avzP --checksum --exclude='*.map' --exclude='*.md5' \
--exclude='/doxygen/xml' --delete --delete-excluded \
Expand Down

0 comments on commit 1c47765

Please sign in to comment.