blob: 52b0e1911c9c535ff7196faa75cd5f84ad7b2524 (
plain) (
blame)
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
43
44
45
46
47
48
49
|
name: api build
on:
push:
tags:
- "v*"
workflow_dispatch:
inputs:
reason:
type: string
required: true
description: 'The reason to manually trigger api doc build'
jobs:
update-api-doc:
runs-on: ubuntu-latest
environment: release
permissions:
contents: write
pull-requests: write
id-token: write
steps:
- uses: actions/checkout@v3
- uses: pdm-project/setup-pdm@v4
name: Setup PDM
with:
python-version: 3.10
# cache: true
- name: sync pdm.lock
run: pdm sync
- name: Install dependencies
run: pdm install -dG docs
- name: Remove API Doc
run: rm -rf docs/source/api
- name: Build API Doc
run: |
pdm run sphinx-apidoc -o docs/source/api hydro_roll -f -e --tocfile index
shell: bash
- name: Commit
uses: stefanzweifel/git-auto-commit-action@v5
with:
branch: master
commit_message: "chore(docs): update api docs with sphinx-apidoc"
|