Skip to content

DOC: Add basic documentation (#3) #2

DOC: Add basic documentation (#3)

DOC: Add basic documentation (#3) #2

Workflow file for this run

name: publish-github-pages
on:
push:
branches:
- develop
paths:
- 'docs/**'
workflow_dispatch:
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: 3.x
- run: pip install mkdocs mkdocs-material mkdocs-glightbox
- name: Build docs site
run: mkdocs build -f docs/mkdocs.yml
- name: Deploy
run: |
cd docs
mkdocs gh-deploy --force