Skip to content

Merge pull request #27 from TeMeta/feat/dta-enablement #3

Merge pull request #27 from TeMeta/feat/dta-enablement

Merge pull request #27 from TeMeta/feat/dta-enablement #3

Workflow file for this run

name: Deploy docs to GitHub Pages
# Fixes #24: GitHub Pages was serving raw Markdown from docs/ instead of the
# MkDocs-built HTML. This workflow builds the site with MkDocs and deploys the
# rendered HTML. After merging, set repo Settings > Pages > Source to "GitHub Actions".
on:
push:
branches: [main]
paths:
- "docs/**"
- "mkdocs.yml"
- ".github/workflows/docs.yml"
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
# Allow one concurrent deployment; don't cancel an in-progress run.
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: Install Poetry
run: pipx install poetry
- name: Install dependencies
run: poetry install --no-interaction --no-root
- name: Build site with MkDocs
run: poetry run mkdocs build
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./site
deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4