Skip to content

Ensure open source standards (#63) #30

Ensure open source standards (#63)

Ensure open source standards (#63) #30

name: Documentation
description: |
This workflow builds the documentation using MkDocs and deploys it to GitHub Pages.
on:
push:
branches:
- main
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.x'
- name: Install dependencies
run: |
pip install mkdocs-jupyter
pip install mkdocs-mermaid2-plugin
- name: Build MkDocs site
run: mkdocs build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site