Skip to content

Update README.md

Update README.md #3

Workflow file for this run

name: ci
on:
push:
branches:
- master
- main
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
# Install uv and enable caching
- name: Install uv
uses: astral-sh/setup-uv@v5
with:
enable-cache: true
cache-dependency-glob: "requirements-docs.txt"
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
# Install your docs requirements via uv
- name: Install docs requirements
run: uv sync --only-group docs
# Run mkdocs in uv's environment
- name: Publish docs
run: uv run mkdocs gh-deploy --force