Skip to content

Commit d7d9731

Browse files
committed
CI: deploy interchange protocol docs on each commit to main
1 parent a841525 commit d7d9731

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

.github/workflows/protocol_docs.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Deploy protocol docs
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
publish:
10+
name: 'Publish'
11+
runs-on: ubuntu-latest
12+
# Avoid running this workflow for forks:
13+
if: "github.repository == 'data-apis/dataframe-api'"
14+
steps:
15+
- name: 'Checkout repository'
16+
uses: actions/checkout@v3
17+
18+
- name: 'Install Python'
19+
uses: actions/setup-python@v4
20+
with:
21+
python-version: '3.10'
22+
23+
- name: 'Install dependencies'
24+
run: pip install -r ./requirements.txt
25+
26+
- name: 'Build documentation'
27+
run: |
28+
# Turn warnings into errors and ensure .doctrees is not deployed:
29+
mkdir site
30+
sphinx-build -b html -WT --keep-going protocol/ site/latest -d doctrees
31+
touch site/.nojekyll
32+
33+
34+
- name: 'Deploy'
35+
uses: peaceiris/actions-gh-pages@v3
36+
if: github.ref == 'refs/heads/main'
37+
with:
38+
personal_token: ${{ secrets.ACTIONS_DEPLOY_TOKEN }}
39+
external_repository: data-apis/dataframe-protocol
40+
publish_branch: main
41+
publish_dir: ./site
42+
user_name: 'github-actions[bot]'
43+
user_email: 'github-actions[bot]@users.noreply.github.com'

0 commit comments

Comments
 (0)