Skip to content

Fix README.md example (#89) #8

Fix README.md example (#89)

Fix README.md example (#89) #8

Workflow file for this run

name: Publish docs
on:
push:
branches:
- main
paths:
- "mkdocs.yml"
- "docs/**"
workflow_dispatch:
permissions:
contents: write
id-token: write
pages: write
jobs:
deploy:
name: Publish docs
runs-on: ubuntu-latest
steps:
- name: Harden the runner (Audit all outbound calls)
uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1
with:
egress-policy: audit
- name: Checkout repository
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- 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: Install Python
uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
with:
python-version: 3.13
- name: Install Python dependencies
run: pip install -r requirements-docs.txt
- name: Set up build cache
uses: actions/cache/restore@0400d5f644dc74513175e3cd8d07132dd4860809 # v4.2.4
with:
key: mkdocs-material-${{ hashfiles('.cache/**') }}
path: .cache
restore-keys: |
mkdocs-material-
- name: Deploy GitHub Pages
run: mkdocs gh-deploy --force
- name: Save build cache
uses: actions/cache/save@0400d5f644dc74513175e3cd8d07132dd4860809 # v4.2.4
with:
key: mkdocs-material-${{ hashfiles('.cache/**') }}
path: .cache