3 |
name: Docs |
name: Docs |
4 |
|
|
5 |
# Controls when the workflow will run |
# Controls when the workflow will run |
6 |
on: [ push, pull_request ] |
on: |
7 |
|
push: |
8 |
|
branches: [ main ] |
9 |
|
|
10 |
# A workflow run is made up of one or more jobs that can run sequentially or in parallel |
# A workflow run is made up of one or more jobs that can run sequentially or in parallel |
11 |
jobs: |
jobs: |
12 |
# This workflow contains a single job called "build" |
# This workflow contains a single job called "build" |
13 |
build: |
docs-deploy: |
14 |
# The type of runner that the job will run on |
# The type of runner that the job will run on |
15 |
runs-on: ubuntu-latest |
runs-on: ubuntu-latest |
16 |
|
|
22 |
- name: Install Mkdocs |
- name: Install Mkdocs |
23 |
run: pip install mkdocs mkdocs-material |
run: pip install mkdocs mkdocs-material |
24 |
|
|
25 |
|
- name: Set version |
26 |
|
run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV |
27 |
|
|
28 |
- name: Build docs |
- name: Build docs |
29 |
run: mkdocs build |
run: mkdocs build |
30 |
|
|