Adds automated MkDocs deployment workflow

Enables automatic documentation deployment to GitHub Pages when documentation files are modified on the master branch.

Triggers on changes to docs directory or mkdocs.yml configuration file to ensure documentation stays current with code changes.
This commit is contained in:
Slipstream 2025-06-11 16:07:12 -06:00
parent 6bcde9c5b0
commit 79642a48da
Signed by: slipstream
GPG Key ID: 13E498CE010AC6FD

31
.github/workflows/docs.yml vendored Normal file
View File

@ -0,0 +1,31 @@
name: Deploy MkDocs
on:
push:
paths:
- 'docs/**'
- 'mkdocs.yml'
branches:
- master
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout source
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.13'
- name: Install dependencies
run: |
pip install mkdocs
- name: Deploy docs
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: mkdocs gh-deploy --force --clean