-
-
Notifications
You must be signed in to change notification settings - Fork 196
47 lines (38 loc) · 1.05 KB
/
documentation.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
name: Documentation
on:
push:
branches: [ 'master' ]
pull_request:
workflow_dispatch:
# Compile the docs and deploy to GitHub pages
jobs:
build:
runs-on: ubuntu-latest
steps:
# Checks out the repository
- uses: actions/checkout@v3
with:
ref: 'master'
- name: Install pandoc
run: sudo apt-get install -y pandoc
# Upgrade pip
- name: Upgrade pip
run: |
# install pip=>20.1 to use "pip cache dir"
python3 -m pip install --upgrade pip
# Cache dependencies
- name: Get pip cache dir
id: pip-cache
run: echo "::set-output name=dir::$(pip cache dir)"
# Install sphinx
- name: Install dependencies
run: python3 -m pip install -r ./docs/requirements.txt
# Make docs
- name: Build docs
run: cd docs && make html
# Deploy
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html/