Skip to content

Docs

Docs #8

Workflow file for this run

name: Docs
on:
workflow_dispatch:
#push:
#branches: ["main"]
#pull_request:
#branches: ["main"]
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
env:
PYTHONUNBUFFERED: "1"
FORCE_COLOR: "1"
jobs:
build:
name: Docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.10"
cache: "pip"
- name: Set up pip cache
if: runner.os == 'Linux'
uses: actions/cache@v4
with:
path: .cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('pyproject.toml') }}
restore-keys: ${{ runner.os }}-pip-
- name: Set up jupyter cache
if: runner.os == 'Linux'
uses: actions/cache@v4
with:
path: .myst_nb_cache
key: myst_nb
- name: Install Hatch
run: pip install --upgrade hatch
- name: Build the docs
run: hatch run docs:build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3.0.1
with:
path: 'gh-pages'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4.0.5