-
Notifications
You must be signed in to change notification settings - Fork 1
31 lines (26 loc) · 948 Bytes
/
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
name: Build Documentation using MkDocs
on:
push:
paths: # Run this action whenever files below change:
- 'docs/**' # - any file under docs
- 'mkdocs.yml' # - mkdocs config file
- '.github/workflows/docs.yml' # - this file
jobs:
build:
name: Build and Deploy Documentation
runs-on: ubuntu-latest
steps:
- name: Checkout the repo
uses: actions/checkout@v2
- name: Setup Python 3.8
uses: actions/setup-python@v2
with:
python-version: '3.8'
- name: Install mkdocs dependencies
run: |
python3 -m pip install --upgrade pip
python3 -m pip install mkdocs mkdocs-material mkdocs-minify-plugin
- name: Deploy
run: |
git pull
mkdocs gh-deploy # build docs and deploy to your github project pages