From a5f1a55920ad7ddaaac0104dc10b3bc985bb0ae2 Mon Sep 17 00:00:00 2001 From: 简律纯 Date: Sun, 10 Mar 2024 07:10:55 +0800 Subject: feat(workflows): build api triggered --- .github/workflows/build-api.yml | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 .github/workflows/build-api.yml (limited to '.github') 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 -- cgit v1.2.3-70-g09d2