Skip to content

Commit

Permalink
chore: Build and deploy docs to GitHub pages
Browse files Browse the repository at this point in the history
  • Loading branch information
jgraichen committed Jan 8, 2025
1 parent fa6e7b6 commit dbcbec4
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
name: docs

on:
push:
workflow_dispatch:

jobs:
build:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.13"
cache: pipenv
- run: pip install pipenv
- run: pipenv install --dev
- run: pipenv run mkdocs build --verbose --site-dir tmp/mkdocs/site
- uses: actions/upload-pages-artifact@v3
with:
path: tmp/mkdocs/site

deploy:
needs: build

permissions:
pages: write
id-token: write

environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

# Only deploy from main branch
if: ${{ github.ref == 'refs/heads/main' }}

runs-on: ubuntu-24.04
steps:
- uses: actions/deploy-pages@v4
id: deployment

0 comments on commit dbcbec4

Please sign in to comment.