Add docs #5
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Build documentation | |
on: | |
pull_request: | |
branches: [main] | |
workflow_call: | |
workflow_dispatch: | |
env: | |
DEB_PYTHON_INSTALL_LAYOUT: deb_system | |
DISPLAY: ":99.0" | |
CI: 1 | |
jobs: | |
build: | |
runs-on: ubuntu-22.04 | |
env: | |
PUBLISH_DIR: ./_build/html | |
DISPLAY: ":99.0" | |
PYVISTA_TRAME_SERVER_PROXY_PREFIX: "/proxy/" | |
PYVISTA_TRAME_SERVER_PROXY_ENABLED: "True" | |
PYVISTA_OFF_SCREEN: false | |
PYVISTA_JUPYTER_BACKEND: "html" | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
- name: Install dependencies for pyvista | |
run: sudo apt-get update && sudo apt-get install -y libgl1-mesa-dev xvfb | |
- name: Setup python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: 3.12 | |
- name: Install dependencies | |
run: python3 -m pip install ".[docs]" | |
- name: Build docs | |
run: jupyter book build -W --keep-going . | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
path: ${{ env.PUBLISH_DIR }} |