Skip to content

Add more documentation (#1218) #40

Add more documentation (#1218)

Add more documentation (#1218) #40

Workflow file for this run

name: docs
on:
workflow_dispatch:
push:
branches:
- main
paths:
- docs/**
pull_request:
types: [opened, synchronize, reopened]
paths:
- docs/**
jobs:
build:
runs-on: ubuntu-latest
if: github.event.repository.fork == false
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Install python3
uses: actions/setup-python@v4
with:
python-version: 3.x
- name: Cache
uses: actions/cache@v3
with:
key: ${{ github.ref }}
path: .cache
- name: Install Material for MkDocs
run: |
pip install mkdocs-material pillow cairosvg
pip install -r docs/mkdocs-material-plugins.txt
- name: Build
run: cd docs && mkdocs build --clean --config-file mkdocs.yaml -d site -v
- name: Publish main
if: github.ref == 'refs/heads/main'
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: docs/site
- name: Publish version
if: startsWith(github.ref, 'refs/tags/v') && !contains(github.ref, 'beta') && !contains(github.ref, 'alpha')
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: docs/site
clean-exclude: dokka/**