2024-10-18 14:48:26 -07:00
|
|
|
name: deploy-docs
|
|
|
|
|
|
|
|
# Run this when the master or main branch changes
|
|
|
|
on:
|
|
|
|
push:
|
|
|
|
branches:
|
|
|
|
- main
|
2024-10-18 14:57:30 -07:00
|
|
|
- doc/main
|
2024-10-18 14:48:26 -07:00
|
|
|
|
|
|
|
# This job installs dependencies, builds the book, and pushes it to `gh-pages`
|
|
|
|
jobs:
|
|
|
|
deploy-book:
|
|
|
|
runs-on: ubuntu-latest
|
|
|
|
permissions:
|
|
|
|
pages: write
|
|
|
|
id-token: write
|
|
|
|
steps:
|
|
|
|
- uses: actions/checkout@v3
|
|
|
|
|
|
|
|
# Install dependencies
|
|
|
|
- name: Set up Python 3.11
|
|
|
|
uses: actions/setup-python@v4
|
|
|
|
with:
|
|
|
|
python-version: 3.11
|
|
|
|
|
2024-10-18 14:56:08 -07:00
|
|
|
- name: Install dependencies
|
|
|
|
run: |
|
2024-10-18 15:27:57 -07:00
|
|
|
pip install poetry
|
|
|
|
poetry install --only doc
|
2024-10-18 14:56:08 -07:00
|
|
|
|
2024-10-18 15:30:12 -07:00
|
|
|
- name: install elan
|
|
|
|
run: |
|
|
|
|
set -o pipefail
|
|
|
|
curl -sSfL https://github.com/leanprover/elan/releases/download/v3.1.1/elan-x86_64-unknown-linux-gnu.tar.gz | tar xz
|
|
|
|
./elan-init -y --default-toolchain none
|
|
|
|
echo "$HOME/.elan/bin" >> "${GITHUB_PATH}"
|
|
|
|
|
2024-10-18 14:48:26 -07:00
|
|
|
# Build the book
|
|
|
|
- name: Build the book
|
|
|
|
run: |
|
2024-10-18 15:27:57 -07:00
|
|
|
poetry run jupyter-book build docs
|
2024-10-18 14:48:26 -07:00
|
|
|
|
|
|
|
# Upload the book's HTML as an artifact
|
|
|
|
- name: Upload artifact
|
|
|
|
uses: actions/upload-pages-artifact@v2
|
|
|
|
with:
|
|
|
|
path: "docs/_build/html"
|
|
|
|
|
|
|
|
# Deploy the book's HTML to GitHub Pages
|
|
|
|
- name: Deploy to GitHub Pages
|
|
|
|
id: deployment
|
|
|
|
uses: actions/deploy-pages@v2
|