Skip to content

Commit 5685c99

Browse files
committed
Adding documentation workflow
1 parent 0b9fd6c commit 5685c99

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

.github/workflows/docs.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Build and Deploy Docs
2+
3+
on:
4+
push:
5+
branches: [dev]
6+
pull_request:
7+
branches: [dev]
8+
9+
jobs:
10+
build-docs:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v3
15+
16+
- name: Set up Python
17+
uses: actions/setup-python@v4
18+
with:
19+
python-version: '3.10'
20+
21+
- name: Install dependencies
22+
run: |
23+
pip install -r docs/requirements-docs.txt
24+
pip install -r requirements.txt
25+
26+
- name: Build docs
27+
run: |
28+
cd docs
29+
make html
30+
31+
- name: Check for broken links
32+
run: |
33+
cd docs
34+
make linkcheck
35+
continue-on-error: true
36+
37+
- name: Deploy to GitHub Pages
38+
if: github.event_name == 'push' && github.ref == 'refs/heads/dev'
39+
uses: peaceiris/actions-gh-pages@v3
40+
with:
41+
github_token: ${{ secrets.GITHUB_TOKEN }}
42+
publish_dir: ./docs/_build/html
43+
cname: isodart.yourdomain.com # Optional: your custom domain

0 commit comments

Comments
 (0)