summaryrefslogtreecommitdiffstats
path: root/.github/workflows/docs_source_update.yml
diff options
context:
space:
mode:
Diffstat (limited to '.github/workflows/docs_source_update.yml')
-rw-r--r--.github/workflows/docs_source_update.yml37
1 files changed, 37 insertions, 0 deletions
diff --git a/.github/workflows/docs_source_update.yml b/.github/workflows/docs_source_update.yml
new file mode 100644
index 0000000..c80ee0b
--- /dev/null
+++ b/.github/workflows/docs_source_update.yml
@@ -0,0 +1,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