fish-audio-python/.github/workflows/docs.yml at main · fishaudio/fish-audio-python · GitHub

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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
name: Documentation

on:
  push:
    branches: [main]
  workflow_dispatch:

jobs:
  update-docs:
    name: Generate Docs
    runs-on: ubuntu-latest
    environment: docs
    steps:
      - name: Checkout fish-audio-python
        uses: actions/checkout@v6
        with:
          path: sdk
          persist-credentials: false

      - name: Install uv
        uses: astral-sh/setup-uv@v7
        with:
          python-version: "3"

      - name: Install dependencies
        working-directory: sdk
        run: uv sync

      - name: Generate API documentation
        working-directory: sdk
        run: uv run poe docs

      - name: Checkout docs
        uses: actions/checkout@v6
        with:
          repository: ${{ vars.DOCS_REPO }}
          path: docs
          persist-credentials: false

      - name: Copy generated documentation
        run: uv run python sdk/scripts/copy_docs.py sdk docs

      - name: Create Pull Request
        uses: peter-evans/create-pull-request@v8
        with:
          token: ${{ secrets.DOCS_TOKEN }}
          path: docs
          commit-message: |
            chore: update Python SDK API reference

            Auto-generated from fishaudio/fish-audio-python@${{ github.sha }}
          author: ${{ vars.BOT_NAME }} <${{ vars.BOT_EMAIL }}>
          committer: ${{ vars.BOT_NAME }} <${{ vars.BOT_EMAIL }}>
          branch: auto/python-api-docs
          delete-branch: true
          title: "Update Python SDK API Reference"
          body: |
            Auto-generated API documentation update from [fish-audio-python@${{ github.sha }}](https://github.com/fishaudio/fish-audio-python/commit/${{ github.sha }})

            ## Changes
            - Updated API reference documentation for Python SDK
            - Generated from latest docstrings in the codebase

          labels: |
            python