Skip to content

Commit

Permalink
ci: add mkdocs action for building and deployment
Browse files Browse the repository at this point in the history
  • Loading branch information
lu-pl committed Feb 4, 2025
1 parent 2cc069c commit ab638ca
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions .github/workflows/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: docs
on:
push:
workflow_dispatch:

jobs:
docs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- name: Install uv
uses: astral-sh/setup-uv@v5
with:
version: "0.5.26"

enable-cache: true
cache-dependency-glob: "uv.lock"

- name: Install dependencies
run: uv sync --dev

- name: Build MkDocs
run: uv run mkdocs build --strict

- name: Deploy MkDocs
if: github.ref == 'refs/heads/main'
run: uv run mkdocs gh-deploy --force

0 comments on commit ab638ca

Please # to comment.