-
Notifications
You must be signed in to change notification settings - Fork 3
42 lines (35 loc) · 893 Bytes
/
update-docs.yml
File metadata and controls
42 lines (35 loc) · 893 Bytes
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
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