Skip to content

Commit 5fb7d4d

Browse files
authored
Add Github Action for Documentation Builds (#256)
1 parent 8cb95b0 commit 5fb7d4d

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Deploy docs
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
8+
jobs:
9+
deploy:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- uses: actions/checkout@v4
14+
with:
15+
fetch-depth: 0
16+
submodules: true
17+
- uses: ammaraskar/sphinx-action@master
18+
with:
19+
docs-folder: "docs/"
20+
- uses: JamesIves/github-pages-deploy-action@v4
21+
with:
22+
branch: gh-pages
23+
folder: docs/build/html
24+
25+

docs/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*build

0 commit comments

Comments
 (0)