1 |
# This is a basic workflow to help you get started with Actions |
2 |
|
3 |
name: Docs |
4 |
|
5 |
# Controls when the workflow will run |
6 |
on: [ push, pull_request ] |
7 |
|
8 |
# A workflow run is made up of one or more jobs that can run sequentially or in parallel |
9 |
jobs: |
10 |
# This workflow contains a single job called "build" |
11 |
docs-build: |
12 |
# The type of runner that the job will run on |
13 |
runs-on: ubuntu-latest |
14 |
|
15 |
# Steps represent a sequence of tasks that will be executed as part of the job |
16 |
steps: |
17 |
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it |
18 |
- uses: actions/checkout@v3 |
19 |
- uses: actions/[email protected] |
20 |
- name: Install Mkdocs |
21 |
run: pip install mkdocs mkdocs-material |
22 |
|
23 |
- name: Build docs |
24 |
run: mkdocs build |