Skip to content
Build and Publish Docs

docs: Adds documentation and GH workflow for build/publish of docs (#21) #1

Sign in to view logs

docs: Adds documentation and GH workflow for build/publish of docs (#21)

docs: Adds documentation and GH workflow for build/publish of docs (#21) #1

Workflow file for this run

.github/workflows/docs.yml at 74a152b
name: Build and Publish Docs
on:
push:
branches:
- main
paths:
- "docs/**"
- "mkdocs.yml"
- "CHANGELOG.md"
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.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v4
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material
- run: mkdocs gh-deploy --force