Skip to content

Deploy MkDocs

Deploy MkDocs #27

Workflow file for this run

name: Deploy MkDocs
on:
workflow_run:
workflows: ["Publish To PyPI"]
types:
- completed
workflow_dispatch:
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup PDM
uses: pdm-project/setup-pdm@v4
- name: Install dependencies
run: pdm install -G docs
- name: Build MkDocs site
run: make generate-docs
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
# - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
# - uses: actions/cache@v4
# with:
# key: mkdocs-material-${{ env.cache_id }}
# path: .cache
# restore-keys: |
# mkdocs-material-
- run: pdm run mkdocs gh-deploy --force