Skip to content

Add sitemap + canonical URLs, fix repo/edit buttons, enable edit button #18

Add sitemap + canonical URLs, fix repo/edit buttons, enable edit button

Add sitemap + canonical URLs, fix repo/edit buttons, enable edit button #18

Workflow file for this run

name: Deploy Jupyter Book to GitHub Pages
on:
push:
branches: [ master ]
paths-ignore:
- 'README.md'
- 'CONTRIBUTING.md'
- 'LICENSE'
pull_request:
paths-ignore:
- 'README.md'
- 'CONTRIBUTING.md'
- 'LICENSE'
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: Setup Python
uses: actions/setup-python@v6
with:
python-version: '3.11'
- name: Install dependencies
run: pip install -r requirements.txt
- name: Build Jupyter Book
run: jupyter-book build . --warningiserror
- name: Setup Pages
if: github.event_name == 'push'
uses: actions/configure-pages@v6
- name: Upload artifact
if: github.event_name == 'push'
uses: actions/upload-pages-artifact@v5
with:
path: _build/html
# Link checking runs independently and never blocks the build or deploy:
# external links can be flaky or rate-limit automated checkers.
linkcheck:
runs-on: ubuntu-latest
continue-on-error: true
steps:
- uses: actions/checkout@v6
- name: Setup Python
uses: actions/setup-python@v6
with:
python-version: '3.11'
- name: Install dependencies
run: pip install -r requirements.txt
- name: Check links
run: jupyter-book build . --builder linkcheck
deploy:
needs: build
if: github.event_name == 'push' && github.ref == 'refs/heads/master'
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v5