Skip to content

Add a docstring page #1

Add a docstring page

Add a docstring page #1

Workflow file for this run

name: Deploy docs to GitHub Pages
on:
push:
branches: [docs]
workflow_dispatch:
permissions:
contents: write
concurrency:
group: pages-deploy
cancel-in-progress: true
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout docs
uses: actions/checkout@v6
- name: Set up Node
uses: actions/setup-node@v4
with:
node-version: 22
cache: npm
- name: Install dependencies
run: npm ci
- name: Build site
run: npm run build
- name: Publish dist to gh-pages
run: |
set -euo pipefail
cd dist
touch .nojekyll
git init
git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
git add -A
git commit -m "Deploy ${GITHUB_SHA}" || true
git branch -M gh-pages
git remote add origin "https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git"
git push -f origin gh-pages