Skip to content

Doc update (#15)

Doc update (#15) #2

Workflow file for this run

---
name: Mkdocs
on:
push:
branches:
- main
paths:
- "docs/**"
- "mkdocs.yml"
jobs:
build_documentation:
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 '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 requirements and build documentation
run: |
python -m pip install --upgrade pip
pip install -r ./docs/requirements.txt
mkdocs build -f mkdocs.yml
mkdocs gh-deploy --force