Merge pull request #236 from choldgraf/patch-2 #86
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
# Deploy the live documentation to our GitHub Pages site | |
name: deploy | |
# Only run this when the master branch changes | |
on: | |
push: | |
branches: | |
- main | |
# This job installs dependencies, builds the book, and pushes it to `gh-pages` | |
jobs: | |
deploy: | |
runs-on: ubuntu-latest | |
# So that we can write to `gh-pages` | |
permissions: | |
contents: write | |
steps: | |
- uses: actions/checkout@v4 | |
# Install dependencies | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: 3.x | |
- uses: actions/cache@v4 | |
with: | |
path: ~/.cache/pip | |
key: ${{ runner.os }}-pip-${{ hashFiles('**/*.md') }} | |
restore-keys: | | |
${{ runner.os }}-pip- | |
- name: Install dependencies | |
run: | | |
pip install jupyter-book | |
# Build the book | |
- name: Build the book | |
run: | | |
jupyter-book build . | |
# Push the book's HTML to github-pages | |
- name: GitHub Pages action | |
uses: peaceiris/actions-gh-pages@v3.5.9 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./_build/html |