Skip to content

Add MkDocs configuration and comprehensive documentation for the Open… #1

Add MkDocs configuration and comprehensive documentation for the Open…

Add MkDocs configuration and comprehensive documentation for the Open… #1

Workflow file for this run

name: Deploy MkDocs site
on:
push:
branches: [main]
paths:
- "docs/**"
- "mkdocs.yml"
- ".github/workflows/mkdocs.yml"
workflow_dispatch:
permissions:
contents: write
jobs:
build-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.x"
- name: Install MkDocs
run: |
python -m pip install --upgrade pip
pip install mkdocs mkdocs-material
- name: Build docs
run: mkdocs build --strict
- name: Deploy to gh-pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site
publish_branch: gh-pages