Skip to content

Docs Site

Docs Site #10

Workflow file for this run

name: Docs Site
on:
release:
types: [published]
workflow_dispatch: {}
permissions:
contents: write
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: "3.x"
- name: Install MkDocs + theme
run: pip install mkdocs mkdocs-material
- name: Build docs (strict)
run: mkdocs build --strict -f docs/mkdocs.yml
- name: Deploy to GitHub Pages
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"
mkdocs gh-deploy --force --no-history -f docs/mkdocs.yml