add workflow to build and deploy docs to github pages

This commit is contained in:
liamcottle 2026-01-28 21:37:21 +13:00
parent a87c0fe2d6
commit 132c8961e8

32
.github/workflows/github-pages.yml vendored Normal file
View file

@ -0,0 +1,32 @@
name: Build and deploy Docs site to GitHub Pages
on:
push:
branches:
- main
permissions:
contents: write
jobs:
github-pages:
runs-on: ubuntu-latest
steps:
- name: Checkout Repo
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
ruby-version: 3.x
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- name: Build and Deploy
run: |
pip install mkdocs-material
mkdocs gh-deploy --force