diff options
Diffstat (limited to '.github/workflows/build-api.yml')
| -rw-r--r-- | .github/workflows/build-api.yml | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/.github/workflows/build-api.yml b/.github/workflows/build-api.yml new file mode 100644 index 0000000..74305aa --- /dev/null +++ b/.github/workflows/build-api.yml @@ -0,0 +1,40 @@ +name: api build + +on: + push: + tags: + - "v*" + workflow_dispatch: + +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.9 + cache: true + - name: Install dependencies + run: pdm install + + - 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"
\ No newline at end of file |