We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 5ef8236 commit 707c79cCopy full SHA for 707c79c
.github/workflows/docs.yaml
@@ -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
27
+ pydoc-markdown -c pydoc-markdown.yml
28
29
+ - name: Commit generated docs if changed
30
+ uses: stefanzweifel/git-auto-commit-action@v4
31
32
+ commit_message: "chore(docs): regenerate API docs"
33
+ file_pattern: "docs/**/*.md"
34
+ branch: development
35
+ push: true
0 commit comments