Skip to content

docs: update README #80

docs: update README

docs: update README #80

Workflow file for this run

name: Publish Docs
on:
push:
branches:
- main
paths:
- 'docs/**'
- mkdocs.yml
- '.github/workflows/docs.yml'
pull_request:
branches:
- docs/**
paths:
- 'docs/**'
- mkdocs.yml
- '.github/workflows/docs.yml'
# Manual triggers
workflow_dispatch:
permissions:
contents: write
concurrency:
group: ${{ github.ref }}
cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
jobs:
publish-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
with:
fetch-depth: 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
- uses: actions/setup-python@v6
with:
python-version: '3.11'
- 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: pip install -r .github/workflows/requirements.txt
- run: mkdocs gh-deploy --force