38 lines (36 loc) · 1.03 KB
/
build-docs.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
name: Documentation
on:
push:
branches:
- main
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2.3.1
with:
persist-credentials: false
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.10'
cache: 'pip'
- name: Install Packages
run: |
sudo apt update
sudo apt-get install graphviz --fix-missing
- name: Install Dependencies
run: |
pip install --upgrade pip
pip install .[dev]
- name: Generate Docs
run: |
make gen-docs
touch docs/_build/html/.nojekyll
- name: Publish Docs
uses: JamesIves/github-pages-deploy-action@3.7.1
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BASE_BRANCH: main # The branch the action should deploy from.
BRANCH: gh-pages # The branch the action should deploy to.
FOLDER: docs/_build/html/ # The folder the action should deploy.