Skip to content

Commit b31da48

Browse files
committed
Add GitHub Pages deployment for Python SDK docs
1 parent 9346d4f commit b31da48

File tree

3 files changed

+412
-2
lines changed

3 files changed

+412
-2
lines changed

.github/workflows/github-pages.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Deploy Python SDK Docs to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
concurrency:
15+
group: "pages"
16+
cancel-in-progress: false
17+
18+
jobs:
19+
deploy:
20+
environment:
21+
name: github-pages
22+
url: ${{ steps.deployment.outputs.page_url }}
23+
runs-on: ubuntu-latest
24+
steps:
25+
- name: Checkout
26+
uses: actions/checkout@v4
27+
28+
- name: Setup Pages
29+
uses: actions/configure-pages@v4
30+
31+
- name: Upload artifact
32+
uses: actions/upload-pages-artifact@v3
33+
with:
34+
path: './docs'
35+
36+
- name: Deploy to GitHub Pages
37+
id: deployment
38+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,7 @@ cython_debug/
163163
!setup.py
164164
!.env.example
165165

166-
# Keep example notebooks
166+
# Keep example notebooks and GitHub Pages docs
167167
!examples/*.ipynb
168-
!docs/*.md
168+
!docs/*.md
169+
!docs/index.html

0 commit comments

Comments
 (0)