Skip to content

Updates documentation and examples. #30

Updates documentation and examples.

Updates documentation and examples. #30

Workflow file for this run

name: Docs Deploy
on:
push:
branches:
- main
permissions:
contents: write
jobs:
deploy:
name: Deploy Docs to GH Pages
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@v4
with:
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v3
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- name: Install dependencies
run: |
pip install poetry
poetry install --with docs
- name: GH Pages deploy
run: |
cd docs
poetry run mkdocs gh-deploy --force