Skip to content

Commit

Permalink
GHA workflow to deploy docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vtnate committed Dec 11, 2024
1 parent 7856e96 commit 84820ce
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .github/workflows/documentation_site.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Documentation
on:
push:
branches:
- main
paths:
- docs/**
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

permissions:
contents: write

jobs:
deploy:
runs-on: ubuntu-latest
environment:
name: github-pages

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.13
- 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 mkdocs-schema-reader mkdocstrings-python markdown-include
- run: mkdocs gh-deploy --force

0 comments on commit 84820ce

Please sign in to comment.