Skip to content

docs: add about page, colophon, and root-level document wrappers #7

docs: add about page, colophon, and root-level document wrappers

docs: add about page, colophon, and root-level document wrappers #7

Workflow file for this run

name: Deploy Documentation to GitHub Pages
on:
push:
branches:
- main
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
build:
name: Build Documentation
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.14'
cache: 'pip'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -e ".[docs]"
- name: Build Static Site with Golem
run: |
golem build --clean
- name: Setup GitHub Pages Configuration
uses: actions/configure-pages@v4
- name: Upload Static Pages Artifact
uses: actions/upload-pages-artifact@v3
with:
# Must match Golem's 'output_dir' configured in pyproject.toml
path: './dist'
deploy:
name: Publish to GitHub Pages
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy Artifact to Pages
id: deployment
uses: actions/deploy-pages@v4