Skip to content

Commit 9bed38f

Browse files
committed
Add workflows by IVS-216 (documentation)
1 parent 64392a0 commit 9bed38f

File tree

2 files changed

+59
-0
lines changed

2 files changed

+59
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: "Build docs with Sphinx and deploy to Github Pages"
2+
3+
on:
4+
push:
5+
branches: docs/gh-pages
6+
7+
jobs:
8+
build_and_deploy:
9+
runs-on: ubuntu-latest
10+
permissions:
11+
contents: write
12+
id-token: write
13+
pages: write
14+
env:
15+
INPUT_DOCS-FOLDER: docs
16+
steps:
17+
- uses: actions/checkout@v4
18+
- name: Build HTML
19+
uses: civilx64/sphinx-action@master
20+
with:
21+
docs-folder: docs/
22+
- name: Setup Pages
23+
uses: actions/configure-pages@v4
24+
- name: Upload artifact
25+
uses: actions/upload-pages-artifact@v3
26+
with:
27+
# Upload html docs
28+
path: './docs/_build/html'
29+
- name: Deploy to GitHub Pages
30+
id: deployment
31+
uses: actions/deploy-pages@v4

.github/workflows/build-docs.yml

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: "Build docs with Sphinx"
2+
3+
on:
4+
pull_request:
5+
branches: docs/gh-pages
6+
7+
jobs:
8+
build_and_deploy:
9+
runs-on: ubuntu-latest
10+
permissions:
11+
contents: write
12+
id-token: write
13+
pages: write
14+
env:
15+
INPUT_DOCS-FOLDER: docs
16+
steps:
17+
- uses: actions/checkout@v4
18+
- name: Build HTML
19+
uses: civilx64/sphinx-action@master
20+
with:
21+
docs-folder: docs/
22+
- name: Setup Pages
23+
uses: actions/configure-pages@v4
24+
- name: Upload artifact
25+
uses: actions/upload-pages-artifact@v3
26+
with:
27+
# Upload html docs
28+
path: './docs/_build/html'

0 commit comments

Comments
 (0)