Skip to content

docs: update

docs: update #2

Workflow file for this run

name: Regenerate API Docs
on:
push:
paths:
- 'src/**'
- 'pyproject.toml'
- 'pydoc-markdown.yml'
workflow_dispatch:
permissions:
contents: write
jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.12'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install .[dev]
- name: Regenerate Markdown API docs
run: |
mkdir -p docs
pydoc-markdown
- name: Commit updated docs
uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: "chore(docs): update generated API docs"
file_pattern: docs/*.md