Skip to content

Commit 8c15dc4

Browse files
authored
Create docs.yml
1 parent b361180 commit 8c15dc4

1 file changed

Lines changed: 44 additions & 0 deletions

File tree

.github/workflows/docs.yml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Deploy MkDocs to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
paths:
7+
- "docs/**"
8+
- "mkdocs.yml"
9+
- "src/**"
10+
workflow_dispatch:
11+
12+
permissions:
13+
contents: read
14+
pages: write
15+
id-token: write
16+
17+
concurrency:
18+
group: "pages"
19+
cancel-in-progress: true
20+
21+
jobs:
22+
build:
23+
runs-on: ubuntu-latest
24+
steps:
25+
- uses: actions/checkout@v4
26+
- uses: actions/setup-python@v5
27+
with:
28+
python-version: "3.11"
29+
cache: "pip"
30+
- run: pip install mkdocs mkdocs-material "mkdocstrings[python]"
31+
- run: mkdocs build --strict
32+
- uses: actions/upload-pages-artifact@v3
33+
with:
34+
path: site
35+
36+
deploy:
37+
environment:
38+
name: github-pages
39+
url: ${{ steps.deployment.outputs.page_url }}
40+
runs-on: ubuntu-latest
41+
needs: build
42+
steps:
43+
- id: deployment
44+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)