summaryrefslogtreecommitdiffstats
path: root/.github/workflows/docs_source_update.yml
blob: c80ee0b9c0439610c9ef8ad0528998d740c79331 (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
name: update docs source

on:
  push:
    branches:
      - main
    paths:
      - pkb_client/**

jobs:
  update:
    name: update docs source
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Set up Python 3.12
        uses: actions/setup-python@v5.3.0
        with:
          python-version: 3.12

      - name: Install sphinx
        run: pip install sphinx

      - name: Build docs source
        run: sphinx-apidoc -f -o docs/source pkb_client

      - name: Open PR with changes
        uses: peter-evans/create-pull-request@v7
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          title: "[Docs]: update docs source"
          commit-message: "update docs source"
          branch: "docs_source_update"
          delete-branch: true
          label: "docs-update"
          add-paths: docs/source