Skip to content

Commit 91af331

Browse files
committed
Add documentation and some base CI files
1 parent e55f648 commit 91af331

File tree

5 files changed

+2134
-411
lines changed

5 files changed

+2134
-411
lines changed

.github/workflows/deploy-mkdocs.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Deploy | Deploy MkDocs
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
branches:
7+
- main
8+
9+
permissions:
10+
contents: write
11+
12+
jobs:
13+
deploy:
14+
runs-on: windows-latest
15+
steps:
16+
- name: Checkout
17+
uses: actions/checkout@v4
18+
19+
- name: Install uv and set the python version
20+
uses: astral-sh/setup-uv@v5
21+
with:
22+
python-version: "3.11"
23+
24+
- name: Install the project
25+
run: uv sync --locked --group docs
26+
27+
- name: Deploy MkDocs
28+
run: mkdocs gh-deploy --force

0 commit comments

Comments
 (0)