Skip to content

Commit 1062501

Browse files
committed
Add docs build and deploy workflow
1 parent 0896b3d commit 1062501

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

.github/workflows/docs.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Docs
2+
on: [push, pull_request]
3+
jobs:
4+
docs:
5+
runs-on: ubuntu-latest
6+
strategy:
7+
fail-fast: false
8+
environment:
9+
name: docs-build-and-deploy
10+
steps:
11+
- uses: actions/checkout@v2
12+
- uses: actions/setup-python@v2
13+
- name: Install Dependencies
14+
run: |
15+
python -m pip install -r docs/requirements.txt
16+
17+
- name: Build Docs
18+
run: |
19+
cd docs
20+
make html
21+
22+
# Note, the gh-pages deployment requires setting up a SSH deploy key.
23+
# See
24+
# https://github.com/JamesIves/github-pages-deploy-action/tree/dev#using-an-ssh-deploy-key-
25+
- name: Deploy
26+
uses: JamesIves/github-pages-deploy-action@v4
27+
if: ${{ github.ref == 'refs/heads/main' }}
28+
with:
29+
folder: docs/_build/html
30+
ssh-key: ${{ secrets.DEPLOY_KEY }}

0 commit comments

Comments
 (0)