Skip to content

Commit

Permalink
docs: run cppyy notebook separately
Browse files Browse the repository at this point in the history
  • Loading branch information
agoose77 committed Nov 12, 2023
1 parent 73a8e96 commit 47899b1
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 1 deletion.
50 changes: 49 additions & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -193,9 +193,51 @@ jobs:
name: awkward
path: dist/awkward*.whl

execute-cppyy:
needs: [awkward-cpp-x86-64, awkward]
runs-on: ubuntu-22.04
name: Execute cppyy notebook
steps:
- uses: actions/checkout@v4
with:
submodules: true

- name: Extract pre-built manylinux cppyy wheels
uses: shrink/actions-docker-extract@v3
with:
image: docker.io/agoose77/cppyy-wheels:cp311
path: /wheels/."
destination: /tmp/wheels/

- name: Download awkward wheel
uses: actions/download-artifact@v3
with:
name: awkward
path: /tmp/wheels/

- name: Download awkward-cpp x86_64 wheel
uses: actions/download-artifact@v3
with:
name: awkward-cpp-x86-64
path: /tmp/wheels/

- name: Install dependencies
working-directory: docs
run: python -m pip install /tmp/wheels/*.whl -r requirements.txt

- name: Execute cppyy notebook
working-directory: docs
run: jupyter nbconvert --to notebook --execute --inplace user-guide/how-to-use-in-cpp-cppyy.ipynb

- name: Save executed notebook
uses: actions/upload-artifact@v3
with:
name: how-to-use-in-cpp-cppyy
path: docs/user-guide/how-to-use-in-cpp-cppyy.ipynb

build-docs:
runs-on: ubuntu-22.04
needs: [awkward-cpp-wasm, awkward-cpp-x86-64, awkward]
needs: [awkward-cpp-wasm, awkward-cpp-x86-64, awkward, execute-cppyy]
name: Build Docs
defaults:
run:
Expand Down Expand Up @@ -275,6 +317,12 @@ jobs:
run: |
echo "DOCS_VERSION=main" >> $GITHUB_ENV
- name: Download cppyy notebook
uses: actions/download-artifact@v3
with:
name: how-to-use-in-cpp-cppyy
path: docs/user-guide

- name: Generate Python documentation
run: sphinx-build -M html . _build/ -T
working-directory: docs
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -326,6 +326,8 @@ jobs:
run: python -m pytest -vv -rs tests

Linux-cppyy:
# TODO: remove this part of the workflow
# cppyy is not yet released. Let's load some pre-built wheels via docker (as a binary store)
runs-on: ubuntu-22.04

env:
Expand Down

0 comments on commit 47899b1

Please sign in to comment.