Skip to content

API docs

API docs #14

Workflow file for this run

name: 'Deploy docs'
on:
push:
branches:
- main
paths:
- "docs/**/*"
- ".github/workflows/docs-gh-pages.yml"
workflow_dispatch:
permissions:
contents: write
jobs:
deploy-docs:
name: Deploy docs
runs-on: ubuntu-latest
steps:
- name: Install graphviz
run: sudo apt-get install -y graphviz
- uses: actions/checkout@v3
with:
ref: gh-pages
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
with:
python-version: '3.9'
- name: Install dependencies
run: |
pip install mkdocs mkdocs-mermaid2-plugin mkdocs-material mkdocs-alias-plugin mkdocs-diagrams mkdocs-macros-plugin pymdown-extensions pygments
- name: Deploy docs
run: mkdocs gh-deploy