Skip to content

Documentation

Documentation #3

Workflow file for this run

name: Documentation
on:
push:
branches:
- main
paths:
- "*.md"
- docs/**
workflow_dispatch:
jobs:
build-doc:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: pdm-project/setup-pdm@v2
with:
python-version: 3.10.5
- name: Build pages
run: |
pip install mkdocs mkdocs-material mkdocs-gen-files
cd docs && mkdocs build
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/site