Skip to content

Commit

Permalink
GitHub workflow to publish documentation
Browse files Browse the repository at this point in the history
Add a github action to build and deploy documentation to the GriHub pages.
  • Loading branch information
mknorps committed Dec 30, 2024
1 parent 76d9d96 commit dfb1799
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Publish docs via GitHub Pages
on:
push:
branches:
- maria/documentation-init
workflow_dispatch:


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

0 comments on commit dfb1799

Please sign in to comment.