Skip to content

Add documentation

Add documentation #1

Workflow file for this run

name: Documentation
on:
push:
branches:
- main
pull_request:
branches:
- main
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.10'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install mkdocs-material mkdocs-include-markdown-plugin
- name: Build documentation
run: mkdocs build
- name: Deploy
if: github.ref == 'refs/heads/main'
run: mkdocs gh-deploy --force