Skip to content

Docs/add more documentation #2

Docs/add more documentation

Docs/add more documentation #2

Workflow file for this run

name: Deploy Documentation
on:
pull_request:
branches:
- main
paths:
- 'docs/**'
- 'mkdocs.yml'
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install dependencies
run: pip install mkdocs-material==9.5.49
- name: Validate documentation build
run: mkdocs build --strict
- name: Deploy documentation
run: mkdocs gh-deploy --force