Skip to content

Rework docs

Rework docs #37

Workflow file for this run

name: Docs
on:
push:
branches:
- main
paths:
- README.md
- guide/**
- examples/**
- _config.yml
- _toc.yml
- pixi.toml
- pixi.lock
- pyproject.toml
- .github/workflows/pages.yml
pull_request:
paths:
- README.md
- guide/**
- examples/**
- _config.yml
- _toc.yml
- pixi.toml
- pixi.lock
- pyproject.toml
- .github/workflows/pages.yml
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: pages
cancel-in-progress: true
jobs:
build:
name: Build Docs
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
- name: Set up Python
uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
with:
python-version: "3.12"
cache: pip
- name: Install Jupyter Book
run: python -m pip install --upgrade "jupyter-book>=1.0.4,<2"
- name: Build site
run: jupyter-book build .
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3
with:
path: _build/html
deploy:
name: Deploy Docs
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4