Skip to content

Commit 4cbd29f

Browse files
committed
Build documentation in CI
1 parent b14e7f7 commit 4cbd29f

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

.github/workflows/docs.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Documentation
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
build:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: actions/checkout@v1
10+
- uses: ammaraskar/sphinx-action@master
11+
with:
12+
docs-folder: doc/
13+
- name: Upload artifact
14+
# Automatically uploads an artifact from the './_site' directory by default
15+
uses: actions/upload-pages-artifact@v1
16+
with:
17+
path: doc/_build/html/
18+
19+
deploy:
20+
if: github.ref == 'refs/heads/master'
21+
runs-on: ubuntu-latest
22+
environment:
23+
name: github-pages
24+
url: ${{ steps.deployment.outputs.page_url }}
25+
needs: build
26+
steps:
27+
- name: Deploy to GitHub Pages
28+
id: deployment
29+
uses: actions/deploy-pages@v1

doc/requirements.txt

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

0 commit comments

Comments
 (0)