Skip to content

Commit aadadc6

Browse files
authored
add pdoc deployment workflow
1 parent 4cc6359 commit aadadc6

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

.github/workflows/pdoc.yml

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: generate and deploy API docs
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v2
14+
with:
15+
persist-credentials: false
16+
- uses: actions/setup-python@v2
17+
- name: Build
18+
run: |
19+
pip install pdoc3
20+
pip install -e .
21+
pdoc --html atmos_cloud_sim_uj_utils
22+
- name: Deploy
23+
if: github.ref == 'refs/heads/main'
24+
uses: JamesIves/[email protected]
25+
with:
26+
BRANCH: pdoc
27+
FOLDER: html/atmos_cloud_sim_uj_utils
28+
CLEAN: true

0 commit comments

Comments
 (0)