Skip to content

Merge pull request #127 from xinan1911/patch-1 #105

Merge pull request #127 from xinan1911/patch-1

Merge pull request #127 from xinan1911/patch-1 #105

Workflow file for this run

# documentation: https://help.github.com/en/articles/workflow-syntax-for-github-actions
name: deploy documentation (only on push to main branch)
on:
push:
branches: main
# Declare default permissions as read only.
permissions: read-all
jobs:
build:
runs-on: ubuntu-22.04
permissions:
# Need to be able to write to the deploy branch
contents: write
steps:
- name: checkout
uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # v3.1.0
with:
fetch-depth: 0 # need to fetch all history to ensure correct Git revision dates in docs
- name: set up Python
uses: actions/setup-python@13ae5bb136fac2878aff31522b9efb785519f984 # v4.3.0
with:
python-version: '3.10'
- name: install mkdocs + plugins
run: |
pip install -r requirements.txt
pip list | grep mkdocs
mkdocs --version
- name: build tutorial
run: make test && make deploy