Skip to content

Commit 707c79c

Browse files
authored
feat: automate docs generation.
1 parent 5ef8236 commit 707c79c

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

.github/workflows/docs.yaml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Generate API docs
2+
3+
on:
4+
push:
5+
branches:
6+
- development
7+
jobs:
8+
build-docs:
9+
runs-on: ubuntu-latest
10+
11+
steps:
12+
- name: Checkout repo
13+
uses: actions/checkout@v4
14+
15+
- name: Set up Python
16+
uses: actions/setup-python@v4
17+
with:
18+
python-version: '3.x'
19+
20+
- name: Install dependencies
21+
run: |
22+
pip install pydoc-markdown
23+
24+
- name: Run pydoc-markdown
25+
working-directory: .
26+
run: |
27+
pydoc-markdown -c pydoc-markdown.yml
28+
29+
- name: Commit generated docs if changed
30+
uses: stefanzweifel/git-auto-commit-action@v4
31+
with:
32+
commit_message: "chore(docs): regenerate API docs"
33+
file_pattern: "docs/**/*.md"
34+
branch: development
35+
push: true

0 commit comments

Comments
 (0)